@adobe/aio-lib-target

v4.0.1

Published

22 days ago

Adobe Target SDK

Downloads

19,018

I/O Adobe Target SDK

Node Javascript Core SDK wrapping Adobe Target APIs.

Installing

$ npm install

Target API Technical Requirements

The Adobe Target 1.0 APIs need to set an Accepts header for them to work properly. With version 2.x or greater of this SDK, we set the proper Accepts header for the calls as documented. Previous versions of this SDK may or may not work since for some Target API calls the Accepts header is not enforced consistently.

User-based OAuth Tokens and Role Requirements

For scenarios in which user-based OAuth tokens are used instead of a JWT technical account ones, the user may require specific roles/permissions to be assigned in Adobe Target in order to successfully perform API calls. Otherwise, the Adobe Target API calls performed by the API Client will result in 500 errors.

For more detailed information, please read the Adobe Target Enterprise user permissions documentation.

Usage

Initialize the SDK

var sdk = require('@adobe/aio-lib-target')

async function sdkTest() {
  //initialize sdk
  const targetClient = await sdk.init('<tenant>', 'x-api-key', '<valid auth token>')
}

Init method returns an Instance of Class TargetCoreAPI

Call methods using initialized sdk

var sdk = require('@adobe/aio-lib-target')

async function sdkTest() {
    //initialize sdk
    const targetClient = await sdk.init('<tenant>', 'x-api-key', '<valid auth token>')

    //get activities
    const activities = await targetClient.getActivities({limit:5, offset:0})
    console.log(util.inspect(activities));

    //get offers
    const offers = await targetClient.getOffers({limit:5, offset:0})
    console.log(util.inspect(offers));

     //get offer by id activity
     const offer = await targetClient.getOfferById(123)
     console.log(util.inspect(offer));
}

All Methods available under sdk are documented here

Classes

Functions

TargetCoreAPI

This class provides methods to call Adobe Target APIs. Before calling any method initialize the instance by calling init method on it with valid tenant, apiKey and auth token

Kind: global class

TargetCoreAPI
- .init(tenant, apiKey, token) ⇒ TargetCoreAPI
- .getActivities([options]) ⇒ Promise.<Response>
- .createABActivity(body, [options]) ⇒ Promise.<Response>
- .createXTActivity(body, [options]) ⇒ Promise.<Response>
- .getABActivityById(id, [options]) ⇒ Promise.<Response>
- .getXTActivityById(id, [options]) ⇒ Promise.<Response>
- .updateABActivity(id, body, [options]) ⇒ Promise.<Response>
- .updateXTActivity(id, body, [options]) ⇒ Promise.<Response>
- .setActivityName(id, name, [options]) ⇒ Promise.<Response>
- .setActivityState(id, state, [options]) ⇒ Promise.<Response>
- .setActivityPriority(id, priority, [options]) ⇒ Promise.<Response>
- .setActivitySchedule(id, schedule, [options]) ⇒ Promise.<Response>
- .deleteABActivity(id, [options]) ⇒ Promise.<Response>
- .deleteXTActivity(id, [options]) ⇒ Promise.<Response>
- .getActivityChangeLog(id, [options]) ⇒ Promise.<Response>
- .getOffers([options]) ⇒ Promise.<Response>
- .getOfferById(id, [options]) ⇒ Promise.<Response>
- .createOffer(body, [options]) ⇒ Promise.<Response>
- .updateOffer(id, body, [options]) ⇒ Promise.<Response>
- .deleteOffer(id, [options]) ⇒ Promise.<Response>
- .getAudiences([options]) ⇒ Promise.<Response>
- .createAudience(body, [options]) ⇒ Promise.<Response>
- .getAudienceById(id, [options]) ⇒ Promise.<Response>
- .updateAudience(id, body, [options]) ⇒ Promise.<Response>
- .deleteAudience(id, [options]) ⇒ Promise.<Response>
- .getProperties([options]) ⇒ Promise.<Response>
- .getPropertyById(id, [options]) ⇒ Promise.<Response>
- .getMBoxes([options]) ⇒ Promise.<Response>
- .getMBoxByName(name, [options]) ⇒ Promise.<Response>
- .getMBoxProfileAttributes([options]) ⇒ Promise.<Response>
- .getEnvironments([options]) ⇒ Promise.<Response>
- .getABActivityPerformance(id, [options]) ⇒ Promise.<Response>
- .getXTActivityPerformance(id, [options]) ⇒ Promise.<Response>
- .getActivityPerformance(id, [options]) ⇒ Promise.<Response>
- .getOrdersReport(id, [options]) ⇒ Promise.<Response>
- .executeBatch(body) ⇒ Promise.<Response>

targetCoreAPI.init(tenant, apiKey, token) ⇒ TargetCoreAPI

Initialize sdk.

Kind: instance method of TargetCoreAPI
Returns: TargetCoreAPI - a TargetCoreAPI instance

| Param | Type | Description | | --- | --- | --- | | tenant | string | Adobe Target tenant name | | apiKey | string | Your api key | | token | string | Valid auth token |

targetCoreAPI.getActivities([options]) ⇒ Promise.<Response>

List activities. Get a list of activities created in your Target account, with the ability to filter and sort by attributes.