Skip to content

Action

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

action_id instance-attribute 

action_id: StringType

The ID associated with the action.

properties instance-attribute 

properties: NotRequired[SynthesizedJsonActionProperties]

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

The keys use camel case names that match the fields in the schema for the Actions dataset. In the previous example, the value matches the 'VALUE' field defined in the Actions schema. For categorical string data, to include multiple categories for a single action, separate each category with a pipe separator (|). For example, \"Deluxe|Premium\".