Remote Config

// access
client.remote_config

Remote Config — server-evaluated, publishable configuration.

Conditions (platform, version, country, percentile, custom user attributes) are evaluated server-side; the SDK receives final values. On the backend this is how you change behaviour — a phone number, a fee, a copy string, a kill switch — without a deploy.

RemoteConfigCopy Anchor Link

client.remote_config

Reads are cached in-process for cache_ttl seconds (default 30) and revalidated with the previous ETag, so a hot path can call get freely. Pass fresh=True to bypass the cache.

Extends Resource.

RemoteConfigCopy Anchor Link

RemoteConfig(client, *, cache_ttl=30.0)

Parameters

defaultsCopy Anchor Link

defaults: Mapping[str, Any]

set_defaults()Copy Anchor Link

def set_defaults(defaults) -> None

In-app fallbacks used when a key is absent or the fetch fails.

Parameters

fetch()Copy Anchor Link

def fetch(context=None, *, etag=None, fresh=False, app_instance_id=None, app_version=None, app_build=None, platform=None, os_version=None, country=None, language=None, first_open_time=None, user_properties=None) -> RemoteConfigSnapshot

Resolve the active template for a context.

user_properties feeds "Custom attribute" conditions; values must be primitives (str/int/float/bool) and match the condition value exactly.

platform defaults to "server". Pass the real platform when resolving config on behalf of a device, or platform conditions will not match.

Parameters

Returns RemoteConfigSnapshot

all()Copy Anchor Link

def all(context=None, **options) -> Dict[str, Any]

Flat {key: value} map, in-app defaults merged in.

Parameters

Returns Dict[str, Any]

get()Copy Anchor Link

def get(key, default=None, context=None, **options) -> Any

One parameter's resolved value, or default.

Parameters

Returns Any

get_string()Copy Anchor Link

def get_string(key, default='', context=None, **o) -> str

Parameters

Returns str

get_bool()Copy Anchor Link

def get_bool(key, default=False, context=None, **o) -> bool

Parameters

Returns bool

get_number()Copy Anchor Link

def get_number(key, default=0.0, context=None, **o) -> float

Parameters

Returns float

get_int()Copy Anchor Link

def get_int(key, default=0, context=None, **o) -> int

Parameters

Returns int

get_json()Copy Anchor Link

def get_json(key, default=None, context=None, **o) -> Any

Parameters

Returns Any

invalidate()Copy Anchor Link

def invalidate() -> None

Drop the in-process cache (next read refetches).

set_parameter()Copy Anchor Link

def set_parameter(key, value=None, *, value_type=None, conditional_values=None, description=None) -> Dict[str, Any]

Create/update a parameter in the draft template.

Nothing changes for clients until publish.

Parameters

Returns Dict[str, Any]

delete_parameter()Copy Anchor Link

def delete_parameter(key) -> None

Remove a parameter from the draft template.

Parameters

publish()Copy Anchor Link

def publish(description=None) -> Dict[str, Any]

Make the draft live. Returns {versionNumber, etag, createdAt}.

Parameters

Returns Dict[str, Any]

set()Copy Anchor Link

def set(key, value, *, value_type=None, description=None) -> Dict[str, Any]

Set one parameter and publish it in a single step.

Parameters

Returns Dict[str, Any]