Personalization API client methods

This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.

This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.

This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.

This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.

This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.

This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.

This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.

This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.

This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.

This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.

List of methods

Add strategy setPersonalizationStrategy setPersonalizationStrategy setPersonalizationStrategy set_personalization_strategy set_personalization_strategy SetPersonalizationStrategy setPersonalizationStrategy SetPersonalizationStrategy set personalizationStrategy setPersonalizationStrategy	Set a personalization strategy.
Get strategy getPersonalizationStrategy getPersonalizationStrategy getPersonalizationStrategy get_personalization_strategy get_personalization_strategy GetPersonalizationStrategy getPersonalizationStrategy GetPersonalizationStrategy getPersonalizationStrategy get personalizationStrategy	Get the personalization strategy.

Guide What is Personalization?

Personalization region

Your Personalization data is stored and processed in a specific region: either in Europe (Germany), or in the United States. When initializing the Personalization client, you need to select your analytics region:

Copy

1
2
3
4
5
6
7
8
9
10
<?php
require_once __DIR__."/vendor/autoload.php";
use Algolia\AlgoliaSearch\PersonalizationClient;

// You need an API key with `editSettings` permission
$personalization = PersonalizationClient::create(
    'YourApplicationID',
    'YourWriteAPIKey',
    'eu' // Default: 'us'
);

1
2
3
4
5
6
7
8
require 'algolia'

# You need an API key with `editSettings` permission
personalization = Algolia::Personalization::Client.create(
  'YourApplicationID',
  'YourAPIKey',
  'eu', # Default: 'us'
)

1
2
3
4
5
6
7
8
const algoliasearch = require('algoliasearch');

// You need an API key with `editSettings` permission
const client = algoliasearch('YourApplicationID', 'YourAPIKey');

const personalization = client.initPersonalization{
  region: 'eu' // Default: 'us'
});

1
2
3
4
5
6
7
from algoliasearch.personalization_client import PersonalizationClient

personalization = PersonalizationClient.create(
    'YourApplicationID',
    'YourWriteAPIKey',
    'eu',  # Default: 'us'
)

1
2
3
4
5
6
7
8
import AlgoliaSearchClient

// You need an API key with `editSettings` permissions
let client = PersonalizationClient(
  appID: "YourApplicationID",
  apiKey: "YourWriteAPIKey",
  region: .us
)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import com.algolia.search.model.APIKey
import com.algolia.search.model.ApplicationID
import com.algolia.search.client.ClientPersonalization
import com.algolia.search.configuration.Region.Personalization.EU
// import com.algolia.search.configuration.Region.Personalization.US

suspend fun main() {
  // You need an API key with `editSettings` permission
  val client = ClientPersonalization(
    applicationID = ApplicationID("YourApplicationID"),
    apiKey = APIKey("YourAPIKey"),
    region = EU // Default: US
  )
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
using Algolia.Search.Clients;

// You need an API key with `editSettings` permission
class Program
{
  public static void Main(string[] args)
  {
    var client = new PersonalizationClient(
        "YourApplicationID",
        "YourAPIKey",
        "eu" // Default: US
    );
  }
}

1
2
3
4
5
6
7
8
import com.algolia.search.DefaultPersonalizationClient;
import com.algolia.search.PersonalizationClient;

public class Program {
  public static void main(String[] args) {
    // You need an API key with `editSettings` permissions
    PersonalizationClient client = DefaultPersonalizationClient.create("YourApplicationID", "YourAPIKey", "eu");
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package main

import (
  "github.com/algolia/algoliasearch-client-go/v3/algolia/personalization"
  "github.com/algolia/algoliasearch-client-go/v3/algolia/region"
)

func main (
  client := personalization.NewClientWithConfig(
    personalization.Configuration {
      AppID: "YourApplicationID",
      APIKey: "YourAPIKey",
      Region: region.EU, // Default: region.US
    }
  )
)

1
2
3
4
5
6
7
8
9
package org.example

import algolia.AlgoliaClient

object Program extends App {
  // You need an API key with `editSettings` permission
  val client = new AlgoliaClient("YourApplicationID", "YourAPIKey")
  client.personalizationHost = "https://personalization.eu.algolia.com"
}

You can check the region for your account in the Algolia dashboard.

Did you find this page helpful?

Personalization API client methods

Personalization region

On this page