Skip to main content

AudienceService API

Audience Service is responsible with subscribing to Segments on DataSapien Mobile Backend to make targeting users possible via Audiences.

To access AudienceService functions; get its instance from DataSapien object: DataSapien.getAudienceService().

Functions (JavaScript)

Public functions

Promise<void>

AudienceService.syncSegmentDefinitions()

Synchronizes segment definitions with the Orchestrator.

Parameters

  • None.

Promise <SegmentDefinition[]>

AudienceService.getSegmentDefinitions()

Retrieves all segment definitions currently available in local storage.

Parameters

  • None.

Promise<void>

AudienceService.syncSegmentSubscriptions()

Synchronizes segment subscriptions with the Orchestrator.

Parameters

  • None.

Promise <SegmentDefinition | null >

AudienceService.getSegmentDefinition(
name: string
)

Retrieves a single segment definition by its name. Returns null if the segment is not found.

Parameters

  • name: string - Name of the segment definition.

Classes (JavaScript)

SegmentDefinition (JavaScript)

{
id: string;
name: string;
text: string;
conditionJson: string;
description?: string | null;
}

SegmentSubscription (JavaScript)

{
segmentDefinitionId: string;
}

Criteria (JavaScript)

{
field: string;
operator: string;
value: string;
}

Filter (JavaScript)

{
type?: string | null;
filters?: Filter[] | null;
filter?: Filter | null;
criteria?: Criteria | null;
}