Thrift module: componentevent

Enumeration: Action

Specific actions that can be taken against a Component. Aim to use one of the existing entries here, or create a new one. The examples in the comments are not intended to be exhaustive. If a general "click" event is enough, consider using the "value" field in ComponentEvent to hold any additional information relating to the click.

INSERT	1	The component was inserted into its container (e.g. a web page or view in an app)
VIEW	2	The component was in view on screen
EXPAND	3	The component was expanded (e.g. "see more"). Not a navigation away to another page
LIKE	4	A "like", thumbs up, etc.
DISLIKE	5	A "dislike", thumbs down, etc.
SUBSCRIBE	6	A subscription to a service, newsletter, etc.
ANSWER	7	Selection of an answer in a quiz
VOTE	8	A vote in a poll
CLICK	9	A single click on the component which is not covered by any of the existing Actions.

Enumeration: ComponentType

The different types of component that can be rendered

READERS_QUESTIONS_ATOM	1
QANDA_ATOM	2
PROFILE_ATOM	3
GUIDE_ATOM	4
TIMELINE_ATOM	5
NEWSLETTER_SUBSCRIPTION	6
SURVEYS_QUESTIONS	7
ACQUISITIONS_EPIC	8
ACQUISITIONS_ENGAGEMENT_BANNER	9
ACQUISITIONS_THANK_YOU_EPIC	10
ACQUISITIONS_HEADER	11
ACQUISITIONS_FOOTER	12
ACQUISITIONS_INTERACTIVE_SLICE	13
ACQUISITIONS_NUGGET	14
ACQUISITIONS_STANDFIRST	15
ACQUISITIONS_THRASHER	16
ACQUISITIONS_EDITORIAL_LINK	17
ACQUISITIONS_MANAGE_MY_ACCOUNT	18
ACQUISITIONS_BUTTON	19
ACQUISITIONS_OTHER	20

Struct: ComponentV2

Key	Field	Type	Description	Requiredness	Default value
1	componentType	ComponentType		required
2	id	string	An ID that can be used to distinguish different instances of a given ComponentType	optional
3	products	set<product.Product>	The products related to the component e.g. a banner with two buttons, one asking for people to become Supporters and one asking for contributions would contain `CONTRIBUTION` and `SUPPORTER`	required
4	campaignCode	string	An optional identifier for the campaign the component was used in	optional
5	labels	set<string>	Additional labels relating to the component	required

Struct: ComponentEvent

Key	Field	Type	Description	Requiredness	Default value
1	component	ComponentV2	The component where the action happened	required
2	action	Action	The action that took place	required
3	value	string	Any additional data on the event, e.g. further information on a "click" event	optional
4	id	string	A unique identifier for the component event e.g. a UUID	optional
5	abTest	abtest.AbTest	If the event was triggered as part of an A/B test, this identifies the test and variant. Though a given pageview may have multiple A/B test participations, a component event can only be associated with a single test.	optional

An event representing an action taken against a component on the web or apps.