amazon-pinpoint/json-schema/amazon-pinpoint-in-app-message-campaign-schema.json at main · api-evangelist/amazon-pinpoint · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-in-app-message-campaign-schema.json",
  "title": "InAppMessageCampaign",
  "description": "Targeted in-app message campaign.",
  "type": "object",
  "properties": {
    "CampaignId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "Campaign id of the corresponding campaign."
        }
      ]
    },
    "DailyCap": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day."
        }
      ]
    },
    "InAppMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InAppMessage"
        },
        {
          "description": "In-app message content with all fields required for rendering an in-app message."
        }
      ]
    },
    "Priority": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "Priority of the in-app message."
        }
      ]
    },
    "Schedule": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InAppCampaignSchedule"
        },
        {
          "description": "Schedule of the campaign."
        }
      ]
    },
    "SessionCap": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session."
        }
      ]
    },
    "TotalCap": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "Total cap which controls the number of times an in-app message can be shown to the endpoint."
        }
      ]
    },
    "TreatmentId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "Treatment id of the campaign."
        }
      ]
    }
  }
}