Sep 20, 2024
Personalization API client
The Personalization API client is part of the algoliasearch
package.
You can add this package to your pom.xml
file for Maven:
Copy
1
2
3
4
5
<dependency>
<groupId>com.algolia</groupId>
<artifactId>algoliasearch</artifactId>
<version>4.7.0</version>
</dependency>
or to your build.gradle
file for Gradle:
Copy
1
implementation 'com.algolia:algoliasearch:4.7.0'
To use the Personalization client, add these imports to your files:
Copy
1
2
import com.algolia.api.PersonalizationClient;
import com.algolia.model.personalization.*;
To create an instance of the client:
Copy
1
PersonalizationClient client = new PersonalizationClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION");
Replace ALGOLIA_APPLICATION_ID_REGION
with your Algolia application’s analytics region: us
for the United States or eu
for Europe.
You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.
List of methods
Each method makes one request to the Personalization API.
Profiles
client.getUserTokenProfile | Retrieve a user profile |
client.deleteUserProfile | Delete a user profile |
Strategies
client.getPersonalizationStrategy | Retrieve the personalization strategy |
client.setPersonalizationStrategy | Define the personalization strategy |
Did you find this page helpful?