/
Manage Segments (Android SDK - Kotlin)

Manage Segments (Android SDK - Kotlin)

Owned by Andrey Veprikov
Last updated: Jun 26, 2024

Adding to a segment

Method Objective

The method allows adding the current user to a segment.

Syntax and parameters

sdk.addToSegment(segmentId, email, phone)

Request parameters

NameTypeRequirementDescription
segmentIdstringrequiredSegment ID. It's available in the PersonaClick account: CRM > Segments.
emailstringoptionallyThe current user's Email.
phonestringoptionally

The current user's phone in full international format.

A phone number in full international format may begin with a plus sign (+) followed by the country code, city (area) code, and phone number.

Examples of use

sdk.addToSegment("100500", "john.doe@examplestore.com", "+10000000000")

sdk.addToSegment("100500", "john.doe@examplestore.com", null)
sdk.addToSegment("100500", null, "+10000000000")
sdk.addToSegment("100500", null, null)

Removing from a segment

Method Objective

The method allows excluding the current user from a segment.

Syntax and parameters

sdk.removeFromSegment(segmentId, email, phone)

Request parameters

NameTypeRequirementDescription
segmentIdstringrequiredSegment ID. It's available in the PersonaClick account: CRM > Segments.
emailstringoptionallyThe current user's Email.
phonestringoptionally

The current user's phone in full international format.

A phone number in full international format may begin with a plus sign (+) followed by the country code, city (area) code, and phone number.

Examples of use

sdk.removeFromSegment("100500", "john.doe@examplestore.com", "+10000000000")

sdk.removeFromSegment("100500", "john.doe@examplestore.com", null)
sdk.removeFromSegment("100500", null, "+10000000000")
sdk.removeFromSegment("100500", null, null)

Getting the segment list

Method Objective

The method allows getting a list of segments that include the current user.

Syntax and parameters

sdk.getCurrentSegment(callback)

NameTypeRequirementDescription
callbackFunctionrequiredThe callback function that takes the API response. The API response type is an object. See the example.

API response

TypeDescription
Object array

Object array, each will have the following properties:

  • id (number) - the Segment ID.
  • type (string) - the Segment Type. It can have the following values: static, dynamic, rfm.

Example of use

PersonaClick.getCurrentSegment(object : OnApiCallbackListener() {
    override fun onSuccess(segments: JSONArray) {
      // segments (type: array of objects)
    }
})

Page Navigation



Related Pages

Related content

Manage Segments (Android SDK - Java)
Manage Segments (Android SDK - Java)
English
More like this
Manage Segments (iOS SDK)
Manage Segments (iOS SDK)
English
More like this
Manage Segments (JS SDK)
Manage Segments (JS SDK)
English
More like this
Manage Segments (RN SDK)
Manage Segments (RN SDK)
English
More like this
Manage Segments (REST API)
Manage Segments (REST API)
English
More like this
User Profile (Android SDK - Kotlin)
User Profile (Android SDK - Kotlin)
English
More like this

Copyright 2018-2024 PersonaClick