Config Center Channel Settings
The AE Engage module provides the Config Center feature, which lets you update your app's appearance and in-app event content without releasing a new version. Config Center offers two ways to get configurations: delivery through a Webhook service and pulling through the client SDK. This section describes how to configure channels for both methods.
- Get via Webhook: Integrate through a lightweight REST API and provide a Webhook URL to receive configuration information, which is adapted and then passed on to downstream systems.
- Get via client SDK: Integrate the AE RemoteConfig SDK to pull configurations on the client.
This article describes the Channel Settings for both methods. After a channel is created, bind it to a config item and verify that the channel works with Send Test in config templates.
Webhook channel
Entry: Config Center - Channel Management - Webhook
Channel Name
The name of the Webhook channel.
Url
The endpoint URL that receives pushed messages.
The Production Environment URL is used to deliver configurations.
The Test Environment URL is used to verify strategies with Send Test.
Custom request headers
When turned on, you can add custom request headers (Header name and Header value) to the requests sent to this URL to pass Authorization, API Key, or business identifier values. You can add up to 10.
Channel authentication
You can turn on channel authentication and enter a secret key to prevent unauthorized calls and make the channel more secure.
User parameters
When you deliver User Level configurations, the AE system pushes the #user_id of the users who meet the target conditions, together with the channel's User Parameters, to the downstream server. Add an ID field that the downstream system can parse as a user parameter (such as #account_id). User parameters are used only for user-level configuration delivery; when you deliver to a target environment, no user property data is provided.
If your scenario involves connecting multiple downstream systems, you can specify a user parameter as the downstream System ID field (for example, when delivering configurations to multiple game servers, specify the server ID as the System ID field). After that, configuration delivery is split by field value, and the webhook relay service only needs to forward each part to its target system. For the delivery format, see Webhook config integration guide.
Environment parameters
Environment parameters specify the target environment of a config strategy. For example, a multi-server game may open an event configuration to some servers, or deliver in-app messages in a given language to users whose system language is that language. In such cases, the delivery target is an environment condition rather than a specific group of users.
For the two scenarios above, add "server" and "language" as environment parameters. Once added, they can be used to configure environment conditions in config strategies. Environment values are passed through directly to the downstream server.
When the environment parameter type is Text, you can specify optional values for the environment parameter. Optional values can be specified in two ways:
- Define them directly in the input box below, for example, Android and iOS for the operating system
- Or get optional values from a configuration table (in this case, only options in the configuration table can be selected as environment values; to keep the configuration table up to date, use the configuration table API to update it).
- Similarly, if your scenario involves connecting multiple downstream systems, you can set an environment parameter as the downstream System ID field. After that, when you suspend a strategy or take it offline, the delivered message also carries the complete list of System ID values, so the downstream webhook service can forward it. For the delivery format, see Webhook config integration guide.
Client channel
Entry: Config Center - Channel Management - Client Channel
Channel Name
The name of the client channel
User parameters
Define the User Properties that you want to deliver to the client along with configurations as User Parameters. When the client requests configurations, the user's parameter values are computed by Real-time calculation and delivered with the configuration.
Environment parameters
Request parameters that a device can carry in its requests. In V4.4, only parameters that the ThinkingData SDK collects automatically are supported as environment parameters. Details:
| Parameter name | Display name | Parameter type | Description |
|---|---|---|---|
| #app_version | App version | Text | Version of the app |
| #bundle_id | Bundle name | Text | App package name or process name |
| #device_model | Device model | Text | Model of the user's device, such as iPhone 8 |
| #device_type | Device Type | Text | Type of the user's device, such as iPad or iPhone |
| #manufacturer | Manufacturer | Text | Manufacturer of the user's device, such as Apple or vivo |
| #network_type | Network Type | Text | Network status when the event occurred, such as WIFI, 3G, or 4G |
| #os | OS | Text | Such as Android or iOS |
| #os_version | OS Version | Text | Such as iOS 11.2.2 or Android 8.0.0 |
| #simulator | Is simulator | Boolean | Whether the device is a simulator: true/false |
| #system_language | System language | Text | System language of the user's device (ISO 639-1, two lowercase letters), such as zh or en |
| #zone_offset | Time Zone Offset | Numeric | Offset in hours of the data time relative to UTC |
| #device_id | Device ID | Text | User's device ID: IDFV or UUID on iOS, androidID on Android |