Skip to content

User

Source code in docs_src/capo_personalize_events/types/user.py 
14
15
16
17
18
19
20
class User(TypedDict, closed=True):
    user_id: "capo_personalize_events.types.string_type.StringType"
    """<p>The ID associated with the user.</p>"""
    properties: NotRequired[
        "capo_personalize_events.types.synthesized_json_user_properties.SynthesizedJsonUserProperties"
    ]
    r"""<p>A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, <code>{"numberOfVideosWatched": "45"}</code>.</p> <p>The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the <code>numberOfVideosWatched</code> matches the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (<code>|</code>). For example, <code>\"Member|Frequent shopper\"</code>.</p>"""

properties instance-attribute 

properties: NotRequired[SynthesizedJsonUserProperties]

A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfVideosWatched": "45"}.

The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the numberOfVideosWatched matches the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (|). For example, \"Member|Frequent shopper\".

user_id instance-attribute 

user_id: StringType

The ID associated with the user.