Remote Config

You are reading the documentation for Bridge SDK v2. If you need the obsolete v1 documentation, see Documentation (v1).

Read game settings (difficulty, drop rates, feature flags, A/B values) from the platform at runtime. This lets you change behavior without shipping a new build. Available on a subset of platforms.

Fetch once at startup before gameplay, and always provide hardcoded defaults for every key. The request can fail, or the platform can return only part of your config.

Support

Check this before requesting remote values. If unsupported, use your local defaults.

bridge.remoteConfig.isSupported

Platform support · 1 of 26 platforms

Supports: yandex

Does not support: crazy_games, discord, dlightek, facebook, game_distribution, gamepush, gamesnacks, huawei, jio_games, lagged, microsoft_store, msn, ok, playdeck, playgama, poki, portal, reddit, samsung, telegram, tiktok, vk, xiaomi, y8, youtube

Set Context

Set dynamic game/player parameters used by the platform for config segmentation (for example, Yandex clientFeatures). Parameters accumulate across calls and are forwarded to the platform SDK on every get().

Call it before get() — for example, right after you know the player's segment.

bridge.remoteConfig.setContext({ segment: 'whales', level: 42 })

Load Values

Load remote values and merge them into your local defaults before gameplay starts. get() takes no arguments — pass segmentation parameters via setContext() beforehand.

bridge.remoteConfig.setContext({ segment: 'whales' }) // optional

bridge.remoteConfig.get()
    .then(data => {
        // your custom data, example: { showFullscreenAdOnStart: 'no', difficulty: 'hard' }
        console.log(data)
    })
    .catch(error => {
        // error
    })

private void Start()
{
    Bridge.remoteConfig.SetContext(new Dictionary<string, object>() { { "segment", "whales" } }); // optional
    Bridge.remoteConfig.Get(OnRemoteConfigGetCompleted);
}

private void OnRemoteConfigGetCompleted(bool success, Dictionary<string, string> data)
{
    if (success)
    {
        // your custom data, example: { showFullscreenAdOnStart: "no", difficulty: "hard" }
        foreach (var pair in data)
        {
            Debug.Log($"{pair.Key}: {pair.Value}");
        }
    }
    else
    {
        // error
    }
}

In the event sheet:

On a trigger (e.g. Button → On clicked), optionally add context with Add Action Parameter / Add Bool Action Parameter, then run Send Remote Config Get Request.
Add the On Remote Config Got Completed condition. Inside it, check Has Remote Config Value for each key and read it with the PlaygamaBridge.RemoteConfigValue("key") expression.

Read loaded values with the PlaygamaBridge.RemoteConfigValue("key") expression after checking the Has Remote Config Value condition.

Copy This Example

{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"on-clicked","objectClass":"Button"}],"actions":[{"id":"add-action-parameter","objectClass":"PlaygamaBridge","parameters":{"key":"\"segment\"","value":"\"whales\""}},{"id":"send-remote-config-get-request","objectClass":"PlaygamaBridge"}]},{"eventType":"block","conditions":[{"id":"on-remote-config-got-completed","objectClass":"PlaygamaBridge"}],"actions":[],"children":[{"eventType":"block","conditions":[{"id":"has-remote-config-value","objectClass":"PlaygamaBridge","parameters":{"key":"\"difficulty\""}}],"actions":[{"id":"log","objectClass":"Browser","parameters":{"type":"log","message":"PlaygamaBridge.RemoteConfigValue(\"difficulty\")"}}]}]}]}

In the events sheet:

On a trigger (e.g. Button is clicked), optionally add context with Add Action Parameter / Add Bool Action Parameter, then run Send Remote Config Get Request.
Add the On Remote Config Got Completed condition. Inside it, check Has Remote Config Value for each key and read it with the PlaygamaBridge::RemoteConfigValue("key") expression.

Read loaded values with the PlaygamaBridge::RemoteConfigValue("key") expression after checking the Has "key" in Remote Config condition.

Copy This Example

{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PanelSpriteButton::PanelSpriteButton::IsClicked"},"parameters":["Button",""]}],"actions":[{"type":{"value":"PlaygamaBridge::AddActionParameter"},"parameters":["","\"segment\"","\"whales\"",""]},{"type":{"value":"PlaygamaBridge::SendRemoteConfigGetRequest"},"parameters":["",""]}]},{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::OnRemoteConfigGotCompleted"},"parameters":["",""]}],"actions":[],"events":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::HasRemoteConfigValue"},"parameters":["","\"difficulty\"",""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["PlaygamaBridge::RemoteConfigValue(\"difficulty\")","\"info\"",""]}]}]}],"eventsCount":2,"actionsList":[],"actionsCount":0,"conditionsList":[],"conditionsCount":0}}

func _ready():
    Bridge.remote_config.set_context({ "segment": "whales" }) # optional
    Bridge.remote_config.get(funcref(self, "_on_remote_config_get_completed"))

func _on_remote_config_get_completed(success, data):
    if success:
        # your custom data, example: { "showFullscreenAdOnStart": "no", "difficulty": "hard" }
        print(data)
    else:
        # error
        pass

func _ready():
    Bridge.remote_config.set_context({ "segment": "whales" }) # optional
    Bridge.remote_config.get(Callable(self, "_on_remote_config_get_completed"))

func _on_remote_config_get_completed(success, data):
    if success:
        # your custom data, example: { "showFullscreenAdOnStart": "no", "difficulty": "hard" }
        print(data)
    else:
        # error
        pass

playgama_bridge_remote_config_set_context(json_stringify({ segment: "whales" })) // optional
playgama_bridge_remote_config_get()

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_remote_config_get_callback" {
    if async_load[? "success"] {
        // your custom data, example: { showFullscreenAdOnStart: "no", difficulty: "hard" }
        var data = json_parse(async_load[? "data"])
    }
}

local bridge = require("bridge.bridge")

function init(self)
	bridge.remote_config.set_context({ segment = "whales" }) -- optional

	bridge.remote_config.get(
		function (_, data)
			-- your custom data, example: { showFullscreenAdOnStart = "no", difficulty = "hard" }
			for key, value in pairs(data) do
				print(key, value)
			end
		end,
		function ()
			-- error
		end
	)
end

bridge.remoteConfig.setContext({ segment: 'whales' }) // optional

bridge.remoteConfig.get()
    .then(data => {
        // your custom data, example: { showFullscreenAdOnStart: 'no', difficulty: 'hard' }
        console.log(data)
    })
    .catch(error => {
        // error
    })

Remote Config here is the platform feature (Yandex Remote Config). Bridge can also merge a remote copy of playgama-bridge-config.json over the local file on any platform — see the remoteConfigUrl option in Setup.

PreviousCross-Promo NextClipboard

Last updated 11 days ago