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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
{
"title": "SimpleSnippet",
"description": "A simple template with an icon, text, and optional button.",
"version": "1.1.2",
"type": "object",
"definitions": {
"plainText": {
"description": "Plain text (no HTML allowed)",
"type": "string"
},
"richText": {
"description": "Text with HTML subset allowed: i, b, u, strong, em, br",
"type": "string"
},
"link_url": {
"description": "Target for links or buttons",
"type": "string",
"format": "uri"
}
},
"properties": {
"title": {
"allOf": [
{ "$ref": "#/definitions/plainText" },
{ "description": "Snippet title displayed before snippet text" }
]
},
"text": {
"allOf": [
{ "$ref": "#/definitions/richText" },
{
"description": "Main body text of snippet. HTML subset allowed: i, b, u, strong, em, br"
}
]
},
"icon": {
"type": "string",
"description": "Snippet icon. 64x64px. SVG or PNG preferred."
},
"icon_dark_theme": {
"type": "string",
"description": "Snippet icon, dark theme variant. 64x64px. SVG or PNG preferred."
},
"icon_alt_text": {
"type": "string",
"description": "Alt text describing icon for screen readers",
"default": ""
},
"title_icon": {
"type": "string",
"description": "Small icon that shows up before the title / text. 16x16px. SVG or PNG preferred. Grayscale."
},
"title_icon_dark_theme": {
"type": "string",
"description": "Small icon that shows up before the title / text. Dark theme variant. 16x16px. SVG or PNG preferred. Grayscale."
},
"title_icon_alt_text": {
"type": "string",
"description": "Alt text describing title icon for screen readers",
"default": ""
},
"button_action": {
"type": "string",
"description": "The type of action the button should trigger."
},
"button_url": {
"allOf": [
{ "$ref": "#/definitions/link_url" },
{ "description": "A url, button_label links to this" }
]
},
"button_action_args": {
"description": "Additional parameters for button action, example which specific menu the button should open"
},
"button_entrypoint_value": {
"description": "String used for telemetry attribution of clicks",
"type": "string"
},
"button_entrypoint_name": {
"description": "String used for telemetry attribution of clicks",
"type": "string"
},
"button_label": {
"allOf": [
{ "$ref": "#/definitions/plainText" },
{
"description": "Text for a button next to main snippet text that links to button_url. Requires button_url."
}
]
},
"button_color": {
"type": "string",
"description": "The text color of the button. Valid CSS color."
},
"button_background_color": {
"type": "string",
"description": "The background color of the button. Valid CSS color."
},
"block_button_text": {
"type": "string",
"description": "Tooltip text used for dismiss button.",
"default": "Remove this"
},
"tall": {
"type": "boolean",
"description": "To be used by fundraising only, increases height to roughly 120px. Defaults to false."
},
"do_not_autoblock": {
"type": "boolean",
"description": "Used to prevent blocking the snippet after the CTA (link or button) has been clicked"
},
"links": {
"additionalProperties": {
"url": {
"allOf": [
{ "$ref": "#/definitions/link_url" },
{ "description": "The url where the link points to." }
]
},
"metric": {
"type": "string",
"description": "Custom event name sent with telemetry event."
},
"args": {
"type": "string",
"description": "Additional parameters for link action, example which specific menu the button should open"
}
}
},
"section_title_icon": {
"type": "string",
"description": "Section title icon. 16x16px. SVG or PNG preferred. section_title_text must also be specified to display."
},
"section_title_icon_dark_theme": {
"type": "string",
"description": "Section title icon, dark theme variant. 16x16px. SVG or PNG preferred. section_title_text must also be specified to display."
},
"section_title_text": {
"type": "string",
"description": "Section title text. section_title_icon must also be specified to display."
},
"section_title_url": {
"allOf": [
{ "$ref": "#/definitions/link_url" },
{ "description": "A url, section_title_text links to this" }
]
}
},
"additionalProperties": false,
"required": ["text"],
"dependencies": {
"button_action": ["button_label"],
"button_url": ["button_label"],
"button_color": ["button_label"],
"button_background_color": ["button_label"],
"section_title_url": ["section_title_text"],
"button_entrypoint_name": ["button_entrypoint_value"]
}
}
|
