Skip to content

SDK API Reference / CASSDK

Class: CASSDK

CAS SDK — composable audience operations

Constructors

Constructor

new CASSDK(context): CASSDK

Parameters

context

SDKContext

Returns

CASSDK

Properties

_connectionSDK?

optional _connectionSDK?: ConnectionSDK

Set by TDX constructor to provide cross-SDK access

Methods

get()

get(idOrName): Promise<ComposableAudience>

Get a composable audience by ID or name

Parameters

idOrName

string

Returns

Promise<ComposableAudience>


list()

list(): Promise<ComposableAudience[]>

List all composable audiences

Returns

Promise<ComposableAudience[]>


listSegments()

listSegments(audienceNameOrId): Promise<ComposableSegment[]>

List segments for a composable audience

Parameters

audienceNameOrId

string

Returns

Promise<ComposableSegment[]>


preview()

preview(audienceNameOrId, segmentNameOrId): Promise<{ customers?: CASPreviewCustomers; query: CASPreviewResult; }>

Preview a composable segment (runs query on CDW). Accepts segment name or ID. Submits query, polls for completion, fetches customer rows.

Parameters

audienceNameOrId

string

segmentNameOrId

string

Returns

Promise<{ customers?: CASPreviewCustomers; query: CASPreviewResult; }>


pull()

pull(nameOrId, options): Promise<CASPullResult>

Pull a composable audience + segments + activations to YAML files

Parameters

nameOrId

string

options

CASPullOptions

Returns

Promise<CASPullResult>


push()

push(files, options?): Promise<CASPushResult>

Push YAML files to CAS API

Parameters

files

string[]

options?

CASPushOptions

Returns

Promise<CASPushResult>


resolveAudienceId()

resolveAudienceId(nameOrId): Promise<string>

Resolve audience name → ID

Parameters

nameOrId

string

Returns

Promise<string>


resolveSegmentId()

resolveSegmentId(audienceNameOrId, segmentNameOrId): Promise<string>

Resolve segment name → ID within an audience

Parameters

audienceNameOrId

string

segmentNameOrId

string

Returns

Promise<string>