tdx

Appearance

SDK API Reference / PersonalizationSDK

Class: PersonalizationSDK ​

Personalization SDK

Methods ​

create() ​

create(parentSegmentId, service): Promise<PersonalizationService>

Create a new personalization service

Parameters ​

parentSegmentId ​

string

Parent segment ID

service ​

PersonalizationService

Service configuration

Returns ​

Promise<PersonalizationService>

Created service

Throws ​

When the create operation fails

Example ​

typescript
const service = await personalization.create('1069944', {
  name: 'My Service',
  trigger_event: 'page_view',
  sections: [...]
});

createPersonalization() ​

createPersonalization(request): Promise<RealtimePersonalization>

Create a realtime personalization entity

Parameters ​

request ​

RealtimePersonalizationCreateRequest

Creation request with attributes and optional relationships

Returns ​

Promise<RealtimePersonalization>

Created realtime personalization

Throws ​

When the create operation fails

Example ​

typescript
const pz = await personalization.createPersonalization({
  attributes: {
    name: 'My Personalization',
    description: 'Serves product recommendations',
    audienceId: '1069944',
    sections: [{ name: 'default', entryCriteria: null, payload: null }],
  },
});

createToken() ​

createToken(parentSegmentId, serviceId, token): Promise<PersonalizationServiceToken>

Create a token for a personalization service

Parameters ​

parentSegmentId ​

string

Parent segment ID

serviceId ​

string

Service ID

token ​

PersonalizationTokenCreateRequest

Token configuration

Returns ​

Promise<PersonalizationServiceToken>

Created token (includes the token value)

Throws ​

When the create operation fails

Example ​

typescript
const token = await personalization.createToken('1069944', 'service123', {
  name: 'My Token',
  allowedIps: ['192.168.1.1'],
});
console.log(token.value); // The actual token string

delete() ​

delete(parentSegmentId, serviceId): Promise<void>

Delete a personalization service

Parameters ​

parentSegmentId ​

string

Parent segment ID

serviceId ​

string

Service ID

Returns ​

Promise<void>

Throws ​

When the delete operation fails

Example ​

typescript
await personalization.delete('1069944', 'service123');

deletePersonalization() ​

deletePersonalization(personalizationId): Promise<void>

Delete a realtime personalization

Parameters ​

personalizationId ​

string

Realtime personalization ID

Returns ​

Promise<void>

Throws ​

When the delete operation fails

Example ​

typescript
await personalization.deletePersonalization('pz123');

deleteToken() ​

deleteToken(parentSegmentId, serviceId, tokenId): Promise<PersonalizationServiceToken>

Delete a token from a personalization service

Parameters ​

parentSegmentId ​

string

Parent segment ID

serviceId ​

string

Service ID

tokenId ​

string

Token ID

Returns ​

Promise<PersonalizationServiceToken>

Deleted token

Throws ​

When the delete operation fails

Example ​

typescript
const deleted = await personalization.deleteToken('1069944', 'service123', 'token456');
console.log(`Deleted token: ${deleted.name}`);

get() ​

get(parentSegmentId, serviceId): Promise<PersonalizationService>

Get a specific personalization service

Parameters ​

parentSegmentId ​

string

Parent segment ID

serviceId ​

string

Service ID

Returns ​

Promise<PersonalizationService>

Personalization service

Throws ​

When the get operation fails

Example ​

typescript
const service = await personalization.get('1069944', 'service123');
console.log(service);

getPersonalization() ​

getPersonalization(personalizationId): Promise<RealtimePersonalization>

Get a specific realtime personalization by ID

Parameters ​

personalizationId ​

string

Realtime personalization ID

Returns ​

Promise<RealtimePersonalization>

Realtime personalization

Throws ​

When the get operation fails

Example ​

typescript
const pz = await personalization.getPersonalization('pz123');
console.log(pz);

list() ​

list(parentSegmentId): Promise<PersonalizationService[]>

List personalization services for a parent segment

Parameters ​

parentSegmentId ​

string

Parent segment ID

Returns ​

Promise<PersonalizationService[]>

Array of personalization services

Throws ​

When the list operation fails

Example ​

typescript
const services = await personalization.list('1069944');
console.log(services);

listPersonalizations() ​

listPersonalizations(parentSegmentId): Promise<RealtimePersonalization[]>

List realtime personalizations for a parent segment

Parameters ​

parentSegmentId ​

string

Parent segment ID

Returns ​

Promise<RealtimePersonalization[]>

Array of realtime personalizations

Throws ​

When the list operation fails

Example ​

typescript
const personalizations = await personalization.listPersonalizations('1069944');
console.log(personalizations);

patch() ​

patch(parentSegmentId, serviceId, patch): Promise<PersonalizationService>

Patch a personalization service (update name and/or description)

Parameters ​

parentSegmentId ​

string

Parent segment ID

serviceId ​

string

Service ID

patch ​

PersonalizationServicePatchRequest

Patch data (name required, description optional)

Returns ​

Promise<PersonalizationService>

Updated service

Throws ​

When the patch operation fails

Example ​

typescript
const updated = await personalization.patch('1069944', 'service123', {
  name: 'New Name',
  description: 'New description',
});

patchPersonalization() ​

patchPersonalization(personalizationId, request): Promise<RealtimePersonalization>

Update (patch) a realtime personalization entity

Parameters ​

personalizationId ​

string

Realtime personalization ID

request ​

RealtimePersonalizationPatchRequest

Patch request (name and description required; sections optional)

Returns ​

Promise<RealtimePersonalization>

Updated realtime personalization

Throws ​

When the patch operation fails

update() ​

update(parentSegmentId, serviceId, service): Promise<PersonalizationService>

Update an existing personalization service

Parameters ​

parentSegmentId ​

string

Parent segment ID

serviceId ​

string

Service ID

service ​

PersonalizationService

Updated service configuration

Returns ​

Promise<PersonalizationService>

Updated service

Throws ​

When the update operation fails

Example ​

typescript
const updated = await personalization.update('1069944', 'service123', {
  name: 'Updated Service',
  ...
});

Copyright 2024-present Treasure Data