You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specification.json
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1061,7 +1061,7 @@
1061
1061
{
1062
1062
"id": "Conditional Requirement 6.1.1.1",
1063
1063
"machine_id": "conditional_requirement_6_1_1_1",
1064
-
"content": "The `client` MUST define a function for tracking the occurrence of a particular action or application state, with parameters `occurrence key` (string, required), `evaluation context` (optional) and `occurrence details` (optional) which returns nothing.",
1064
+
"content": "The `client` MUST define a function for tracking the occurrence of a particular action or application state, with parameters `tracking event name` (string, required), `evaluation context` (optional) and `tracking event details` (optional), which returns nothing.",
1065
1065
"RFC 2119 keyword": "MUST",
1066
1066
"children": []
1067
1067
}
@@ -1076,7 +1076,7 @@
1076
1076
{
1077
1077
"id": "Conditional Requirement 6.1.2.1",
1078
1078
"machine_id": "conditional_requirement_6_1_2_1",
1079
-
"content": "The `client` MUST define a function for tracking the occurrence of a particular action or application state, with parameters `occurrence key` (string, required) and `occurrence details` (optional) which returns nothing.",
1079
+
"content": "The `client` MUST define a function for tracking the occurrence of a particular action or application state, with parameters `tracking event name` (string, required) and `tracking event details` (optional), which returns nothing.",
1080
1080
"RFC 2119 keyword": "MUST",
1081
1081
"children": []
1082
1082
}
@@ -1099,14 +1099,14 @@
1099
1099
{
1100
1100
"id": "Requirement 6.2.1",
1101
1101
"machine_id": "requirement_6_2_1",
1102
-
"content": "The `occurrence details` structure MUST define an optional numeric `value`, associating a scalar quality with an `occurrence`.",
1102
+
"content": "The `tracking event details` structure MUST define an optional numeric `value`, associating a scalar quality with an `tracking event`.",
1103
1103
"RFC 2119 keyword": "MUST",
1104
1104
"children": []
1105
1105
},
1106
1106
{
1107
1107
"id": "Requirement 6.2.2",
1108
1108
"machine_id": "requirement_6_2_2",
1109
-
"content": "The `occurrence details` MUST support the inclusion of custom fields, having keys of type `string`, and values of type `boolean | string | number | structure`.",
1109
+
"content": "The `tracking event details` MUST support the inclusion of custom fields, having keys of type `string`, and values of type `boolean | string | number | structure`.",
@@ -201,7 +201,7 @@ Pseudorandomly resolve flag values using a context property, such as a targeting
201
201
202
202
A rule is some criteria that's used to determine which variant a particular context should be mapped to.
203
203
204
-
### Tracking Occurrence
204
+
### Tracking Event
205
205
206
206
A particular user action or application state representing a business objective or outcome, identified by a unique string, and recorded using the [tracking API](./sections/06-tracking.md).
> The `client`**MUST** define a function for tracking the occurrence of a particular action or application state, with parameters `occurrence key` (string, required), `evaluation context` (optional) and `occurrence details` (optional) which returns nothing.
36
+
> The `client`**MUST** define a function for tracking the occurrence of a particular action or application state, with parameters `tracking event name` (string, required), `evaluation context` (optional) and `tracking event details` (optional), which returns nothing.
37
37
38
38
```java
39
-
// example tracking occurrence recording that a subject reached a page associated with a business goal
39
+
// example tracking event recording that a subject reached a page associated with a business goal
// example tracking occurrence recording that a subject performed an action associated with a business goal, with the occurrence details having a particular numeric value
// example tracking event recording that a subject performed an action associated with a business goal, with the tracking event details having a particular numeric value
// example tracking occurrence recording that a subject performed an action associated with a business goal, with the occurrence details having a particular numeric value
// example tracking event recording that a subject performed an action associated with a business goal, with the tracking event details having a particular numeric value
> The `client`**MUST** define a function for tracking the occurrence of a particular action or application state, with parameters `occurrence key` (string, required) and `occurrence details` (optional) which returns nothing.
61
+
> The `client`**MUST** define a function for tracking the occurrence of a particular action or application state, with parameters `tracking event name` (string, required) and `tracking event details` (optional), which returns nothing.
62
62
63
63
The track function is a void function (function returning nothing).
64
64
Though it may be associated with network activity or other I/O, it need not be awaited by application authors.
65
65
66
66
```java
67
-
// example tracking occurrence recording that a subject reached a page associated with a business goal
67
+
// example tracking event recording that a subject reached a page associated with a business goal
68
68
client.track("visited-promo-page");
69
69
70
-
// example tracking occurrence recording that a subject performed an action associated with a business goal, with the occurrence details having a particular numeric value
// example tracking event recording that a subject performed an action associated with a business goal, with the tracking event details having a particular numeric value
// example tracking occurrence recording that a subject performed an action associated with a business goal, with the occurrence details having a particular numeric and some additional details
// example tracking event recording that a subject performed an action associated with a business goal, with the tracking event details having a particular numeric and some additional details
@@ -86,22 +86,22 @@ See: [context levels and merging](./03-evaluation-context.md#32-context-levels-a
86
86
87
87
> If the client's `track` function is called and the associated provider does not implement tracking, the client's `track` function **MUST** no-op.
88
88
89
-
### 6.2. Occurrence Details
89
+
### 6.2. Tracking Event Details
90
90
91
-
The `occurrence details` structure defines optional data pertinent to a particular `occurrence`.
91
+
The `tracking event details` structure defines optional data pertinent to a particular `tracking event`.
92
92
93
93
#### Requirement 6.2.1
94
94
95
-
> The `occurrence details` structure **MUST** define an optional numeric `value`, associating a scalar quality with an `occurrence`.
95
+
> The `tracking event details` structure **MUST** define an optional numeric `value`, associating a scalar quality with an `tracking event`.
96
96
97
97
`Value` is a well-defined field which some providers may map to equivalent numeric values in their API.
98
98
99
99
See [provider tracking support](./02-providers.md#27-tracking-support).
100
100
101
101
#### Requirement 6.2.2
102
102
103
-
> The `occurrence details`**MUST** support the inclusion of custom fields, having keys of type `string`, and values of type `boolean | string | number | structure`.
103
+
> The `tracking event details`**MUST** support the inclusion of custom fields, having keys of type `string`, and values of type `boolean | string | number | structure`.
104
104
105
-
The `occurrence details` supports the addition of arbitrary fields, including nested objects, similar to the `evaluation context` and object-typed flag values.
105
+
The `tracking event details` supports the addition of arbitrary fields, including nested objects, similar to the `evaluation context` and object-typed flag values.
106
106
107
107
See [structure](../types.md#structure), [evaluation context](.//03-evaluation-context.md).
Copy file name to clipboardExpand all lines: specification/types.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -189,6 +189,8 @@ An enumeration of provider events.
189
189
A function or method which can be associated with a `provider event`, and runs when that event occurs.
190
190
It declares an `event details` parameter.
191
191
192
-
### Occurrence Details
192
+
### Tracking Event Details
193
193
194
-
See [occurrence details](./sections/06-tracking.md#62-occurrence-details).
194
+
A structure which supports definition of arbitrary properties, including nested objects, similar to the `evaluation context` and object-typed flag values.
195
+
196
+
See [tracking event details](./sections/06-tracking.md#62-tracking-event-details), [evaluation context](#evaluation-context).
0 commit comments