服务端 SDK

客户端设置

如何初始化 Python SDK 客户端和用户数据

在发送任何事件之前,您需要使用 API 密钥和基础 URL 创建客户端实例,并准备用户数据对象。

from audiencelab_python_sdk import (
    Client, UserData, RegisterUser, FetchToken,
    RetentionData, PurchaseData, AdData, AppEvent
)

api_key = "your_api_key"
base_url = "https://example.com"
client = Client(api_key, base_url)

user_data = UserData() \
    .set_user_id("user_12345") \
    .set_user_ip("123.123.1.1") \
    .set_event_timestamp("2024-10-05T16:48:00+02:00") \
    .set_device_info({
        "device_name": "My Device",
        "height": 2436,
        "width": 1125,
        "os": "iOS",
        "os_version": "14.4",
        "device_model": "iPhone15,4",
        "timezone": "America/New_York"
    })

⚠️ 重要: 详细的 device_info 仅在初始用户注册时需要。 对于后续事件,您只需要提供 user_id 和 user_ip。

UserData 方法

Prop

Type

设备信息对象

Prop

Type

创意令牌信息对象

创意令牌由 AudienceLab 后端签发,您无需自行设置。请先注册用户(首次启动)或获取令牌(回访用户),然后将响应传回 UserData

response = RegisterUser(client, user_data).send()
user_data.set_user_creative_token_info(response)

set_user_creative_token_info(response) 会从后端响应中读取 creative_token、留存状态和累计值并存储到 user_data,供后续事件调用使用。下表说明后端响应中包含的字段:

Prop

Type

如果事件不是实时发生的,请包含 ISO 8601 格式的 event_timestamp。

现在您已准备好注册用户或获取创意令牌。