Пользовательский эндпоинт SDK

Как настроить пользовательский эндпоинт Appodeal SDK?

В некоторых случаях стандартный серверный эндпоинт Appodeal может быть недоступен в определённых регионах или локациях. Для решения этой проблемы в SDK 4.1.0 был добавлен API Set Endpoint, который позволяет заменить стандартный серверный эндпоинт на пользовательский, предоставленный поддержкой Appodeal.

warning

Set Endpoint необходимо вызывать до инициализации Appodeal. Если вызвать после инициализации, изменение эндпоинта будет проигнорировано.

Справочник API

Android

Kotlin

// Установка пользовательского эндпоинта перед инициализацией
Appodeal.setEndpoint("https://provided-endpoint.example.com")

// Инициализация SDK как обычно
Appodeal.initialize(this, "YOUR_APP_KEY", adTypes)

// Проверка текущего эндпоинта (опционально)
val currentEndpoint = Appodeal.getEndpoint()

Java

// Установка пользовательского эндпоинта перед инициализацией
Appodeal.setEndpoint("https://provided-endpoint.example.com");

// Инициализация SDK как обычно
Appodeal.initialize(this, "YOUR_APP_KEY", adTypes);

// Проверка текущего эндпоинта (опционально)
String currentEndpoint = Appodeal.getEndpoint();

iOS

Swift

// Установка пользовательского эндпоинта перед инициализацией
Appodeal.setEndpoint("https://provided-endpoint.example.com")

// Инициализация SDK как обычно
Appodeal.initialize(withApiKey: "YOUR_APP_KEY", types: adTypes)

// Проверка текущего эндпоинта (опционально)
let currentEndpoint = Appodeal.getEndpoint()

Objective-C

// Установка пользовательского эндпоинта перед инициализацией
[Appodeal setEndpoint:@"https://provided-endpoint.example.com"];

// Инициализация SDK как обычно
[Appodeal initializeWithApiKey:@"YOUR_APP_KEY" types:adTypes];

// Проверка текущего эндпоинта (опционально)
NSString *currentEndpoint = [Appodeal getEndpoint];

Unity

// Установка пользовательского эндпоинта перед инициализацией
Appodeal.SetEndpoint("https://provided-endpoint.example.com");

// Инициализация SDK как обычно
Appodeal.Initialize("YOUR_APP_KEY", adTypes);

// Проверка текущего эндпоинта (опционально)
string currentEndpoint = Appodeal.GetEndpoint();

Удалённая настройка эндпоинта

Мы рекомендуем управлять URL эндпоинта через сервис удалённой конфигурации, а не прописывать его в коде. Это позволяет обновлять эндпоинт без выпуска новой версии приложения.

Общий подход:

1. Создайте параметр удалённой конфигурации (например, appodeal_endpoint) с пустым значением по умолчанию.
2. При запуске приложения получите значения конфигурации.
3. Если параметр не пустой, вызовите Set Endpoint с полученным значением перед инициализацией Appodeal.

Firebase Remote Config

См. документацию Firebase Remote Config для инструкций по настройке.

Android

Kotlin

val remoteConfig = Firebase.remoteConfig

// Значение по умолчанию (пустая строка — используется стандартный эндпоинт SDK)
remoteConfig.setDefaultsAsync(mapOf("appodeal_endpoint" to ""))

remoteConfig.fetchAndActivate().addOnCompleteListener { task ->
    val endpoint = remoteConfig.getString("appodeal_endpoint")

    if (endpoint.isNotEmpty()) {
        Appodeal.setEndpoint(endpoint)
    }

    Appodeal.initialize(this, "YOUR_APP_KEY", adTypes)
}

Java

FirebaseRemoteConfig remoteConfig = FirebaseRemoteConfig.getInstance();

// Значение по умолчанию (пустая строка — используется стандартный эндпоинт SDK)
Map<String, Object> defaults = new HashMap<>();
defaults.put("appodeal_endpoint", "");
remoteConfig.setDefaultsAsync(defaults);

remoteConfig.fetchAndActivate().addOnCompleteListener(task -> {
    String endpoint = remoteConfig.getString("appodeal_endpoint");

    if (!endpoint.isEmpty()) {
        Appodeal.setEndpoint(endpoint);
    }

    Appodeal.initialize(this, "YOUR_APP_KEY", adTypes);
});

iOS

Swift

let remoteConfig = RemoteConfig.remoteConfig()

// Значение по умолчанию (пустая строка — используется стандартный эндпоинт SDK)
remoteConfig.setDefaults(["appodeal_endpoint": "" as NSObject])

remoteConfig.fetchAndActivate { status, error in
    let endpoint = remoteConfig.configValue(forKey: "appodeal_endpoint").stringValue ?? ""

    if !endpoint.isEmpty {
        Appodeal.setEndpoint(endpoint)
    }

    Appodeal.initialize(withApiKey: "YOUR_APP_KEY", types: adTypes)
}

Objective-C

FIRRemoteConfig *remoteConfig = [FIRRemoteConfig remoteConfig];

// Значение по умолчанию (пустая строка — используется стандартный эндпоинт SDK)
[remoteConfig setDefaults:@{@"appodeal_endpoint": @""}];

[remoteConfig fetchAndActivateWithCompletionHandler:^(FIRRemoteConfigFetchAndActivateStatus status, NSError *error) {
    NSString *endpoint = [remoteConfig configValueForKey:@"appodeal_endpoint"].stringValue;

    if (endpoint.length > 0) {
        [Appodeal setEndpoint:endpoint];
    }

    [Appodeal initializeWithApiKey:@"YOUR_APP_KEY" types:adTypes];
}];

Unity

var remoteConfig = FirebaseRemoteConfig.DefaultInstance;

// Значение по умолчанию (пустая строка — используется стандартный эндпоинт SDK)
var defaults = new Dictionary<string, object> {
    { "appodeal_endpoint", "" }
};

remoteConfig.SetDefaultsAsync(defaults).ContinueWithOnMainThread(task => {
    remoteConfig.FetchAndActivateAsync().ContinueWithOnMainThread(fetchTask => {
        string endpoint = remoteConfig.GetValue("appodeal_endpoint").StringValue;

        if (!string.IsNullOrEmpty(endpoint)) {
            Appodeal.SetEndpoint(endpoint);
        }

        Appodeal.Initialize("YOUR_APP_KEY", adTypes);
    });
});

AppMetrica Startup Parameters

См. примеры использования AppMetrica Startup Parameters для Android, iOS и Unity.

Android

Kotlin

val callback = object : StartupParamsCallback {
    override fun onReceive(result: StartupParamsCallback.Result?) {
        val endpoint = result?.parameterForKey("appodeal_endpoint") ?: ""

        if (endpoint.isNotEmpty()) {
            Appodeal.setEndpoint(endpoint)
        }

        Appodeal.initialize(this@MainActivity, "YOUR_APP_KEY", adTypes)
    }

    override fun onRequestError(
        reason: StartupParamsCallback.Reason,
        result: StartupParamsCallback.Result?
    ) {}
}

AppMetrica.requestStartupParams(this, callback, listOf("appodeal_endpoint"))

Java

StartupParamsCallback callback = new StartupParamsCallback() {
    @Override
    public void onReceive(@Nullable StartupParamsCallback.Result result) {
        String endpoint = result != null ? result.parameterForKey("appodeal_endpoint") : null;

        if (endpoint != null && !endpoint.isEmpty()) {
            Appodeal.setEndpoint(endpoint);
        }

        Appodeal.initialize(MainActivity.this, "YOUR_APP_KEY", adTypes);
    }

    @Override
    public void onRequestError(
        @NonNull StartupParamsCallback.Reason reason,
        @Nullable StartupParamsCallback.Result result
    ) {}
};

AppMetrica.requestStartupParams(this, callback, Arrays.asList("appodeal_endpoint"));

iOS

Swift

let endpointKey = StartupKey("appodeal_endpoint")

AppMetrica.requestStartupIdentifiers(
    for: [endpointKey],
    on: .main
) { identifiers, error in
    if let endpoint = identifiers?[endpointKey] as? String, !endpoint.isEmpty {
        Appodeal.setEndpoint(endpoint)
    }

    Appodeal.initialize(withApiKey: "YOUR_APP_KEY", types: adTypes)
}

Objective-C

AMAStartupKey endpointKey = @"appodeal_endpoint";

[AMAAppMetrica requestStartupIdentifiersWithKeys:@[endpointKey]
                                 completionQueue:dispatch_get_main_queue()
                                 completionBlock:^(NSDictionary<AMAStartupKey, id> *identifiers, NSError *error) {
    NSString *endpoint = identifiers[endpointKey];

    if (endpoint.length > 0) {
        [Appodeal setEndpoint:endpoint];
    }

    [Appodeal initializeWithApiKey:@"YOUR_APP_KEY" types:adTypes];
}];

Unity

AppMetrica.RequestStartupParams(
    (result, errorReason) => {
        if (result != null) {
            string endpoint = result.ParameterForKey("appodeal_endpoint");

            if (!string.IsNullOrEmpty(endpoint)) {
                Appodeal.SetEndpoint(endpoint);
            }
        }

        Appodeal.Initialize("YOUR_APP_KEY", adTypes);
    },
    new[] { "appodeal_endpoint" }
);

Важные замечания

к сведению

• Пользовательский URL эндпоинта будет предоставлен поддержкой Appodeal при необходимости — не указывайте произвольные URL.
• Используйте Get Endpoint для проверки текущего активного эндпоинта в целях отладки.