Skip to content

InAppMessageCampaign

Source code in docs_src/capo_pinpoint/types/in_app_message_campaign.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class InAppMessageCampaign(TypedDict, closed=True):
    campaign_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>Campaign id of the corresponding campaign.</p>"""
    daily_cap: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.</p>"""
    in_app_message: NotRequired["capo_pinpoint.types.in_app_message.InAppMessage"]
    """<p>In-app message content with all fields required for rendering an in-app message.</p>"""
    priority: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>Priority of the in-app message.</p>"""
    schedule: NotRequired[
        "capo_pinpoint.types.in_app_campaign_schedule.InAppCampaignSchedule"
    ]
    """<p>Schedule of the campaign.</p>"""
    session_cap: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.</p>"""
    total_cap: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>Total cap which controls the number of times an in-app message can be shown to the endpoint.</p>"""
    treatment_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>Treatment id of the campaign.</p>"""

campaign_id instance-attribute 

campaign_id: NotRequired[__string]

Campaign id of the corresponding campaign.

daily_cap instance-attribute 

daily_cap: NotRequired[__integer]

Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.

in_app_message instance-attribute 

in_app_message: NotRequired[InAppMessage]

In-app message content with all fields required for rendering an in-app message.

priority instance-attribute 

priority: NotRequired[__integer]

Priority of the in-app message.

schedule instance-attribute 

schedule: NotRequired[InAppCampaignSchedule]

Schedule of the campaign.

session_cap instance-attribute 

session_cap: NotRequired[__integer]

Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.

total_cap instance-attribute 

total_cap: NotRequired[__integer]

Total cap which controls the number of times an in-app message can be shown to the endpoint.

treatment_id instance-attribute 

treatment_id: NotRequired[__string]

Treatment id of the campaign.