-
Notifications
You must be signed in to change notification settings - Fork 58
/
ClickStream.java
243 lines (206 loc) · 6.86 KB
/
ClickStream.java
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.dataflow.sample.retail.dataobjects;
import com.google.auto.value.AutoValue;
import javax.annotation.Nullable;
import org.apache.beam.sdk.annotations.Experimental;
import org.apache.beam.sdk.schemas.AutoValueSchema;
import org.apache.beam.sdk.schemas.annotations.DefaultSchema;
import org.apache.beam.sdk.schemas.annotations.SchemaFieldName;
/**
* Objects used for dealing with clickstream within the pipeline and schemas for I/O of clickstream
* events. Example events:
*
* <p>View Item
*
* <pre>{@code
* {
* "event_datetime":"2020-11-16 22:59:59",
* "event": "view_item",
* "user_id": "UID00003",
* "client_id": "CID00003",
* "page":"/product-67890",
* "page_previous": "/category-tshirts",
* "ecommerce": {
* "items": [{
* "item_name": "Donut Friday Scented T-Shirt",
* "item_id": "67890",
* "price": 33.75,
* "item_brand": "Google",
* "item_category": "Apparel",
* "item_category_2": "Mens",
* "item_category_3": "Shirts",
* "item_category_4": "Tshirts",
* "item_variant": "Black",
* "item_list_name": "Search Results",
* "item_list_id": "SR123",
* "index": 1,
* "quantity": 1
* }]
* }
* }
*
*
* }</pre>
*
* add_to_cart
*
* <pre>{@code
* {
* "event_datetime":"2020-11-16 20:59:59",
* "event": "add_to_cart",
* "user_id": "UID00003",
* "client_id": "CID00003",
* "page":"/product-67890",
* "page_previous": "/category-tshirts",
* "ecommerce": {
* "items": [{
* "item_name": "Donut Friday Scented T-Shirt",
* "item_id": "67890",
* "price": 33.75,
* "item_brand": "Google",
* "item_category": "Apparel",
* "item_category_2": "Mens",
* "item_category_3": "Shirts",
* "item_category_4": "Tshirts",
* "item_variant": "Black",
* "item_list_name": "Search Results",
* "item_list_id": "SR123",
* "index": 1,
* "quantity": 2
* }]
* }
* }
*
* }</pre>
*
* purchase
*
* <pre>{@code
* {
* "event_datetime":"2020-11-16 20:59:59",
* "event": "purchase",
* "user_id": "UID00001",
* "client_id": "CID00003",
* "page":"/checkout",
* "page_previous": "/order-confirmation",
* "ecommerce": {
* "purchase": {
* "transaction_id": "T12345",
* "affiliation": "Online Store",
* "value": 35.43,
* "tax": 4.90,
* "shipping": 5.99,
* "currency": "EUR",
* "coupon": "SUMMER_SALE",
* "items": [{
* "item_name": "Triblend Android T-Shirt",
* "item_id": "12345",
* "item_price": 15.25,
* "item_brand": "Google",
* "item_category": "Apparel",
* "item_variant": "Gray",
* "quantity": 1,
* "item_coupon": ""
* }, {
* "item_name": "Donut Friday Scented T-Shirt",
* "item_id": "67890",
* "item_price": 33.75,
* "item_brand": "Google",
* "item_category": "Apparel",
* "item_variant": "Black",
* "quantity": 1
* }]
* }
* }
* }
*
* }</pre>
*/
@Experimental
public class ClickStream {
@AutoValue
@DefaultSchema(AutoValueSchema.class)
/**
* The Clickstream event represents actions that a user has taken on the website or mobile
* application.
*/
public abstract static class ClickStreamEvent {
@SchemaFieldName("event_datetime")
public @Nullable abstract String getEventTime();
@SchemaFieldName("event")
public @Nullable abstract String getEvent();
@SchemaFieldName("timestamp")
public @Nullable abstract Long getTimestamp();
@SchemaFieldName("user_id")
public @Nullable abstract Long getUid();
@SchemaFieldName("client_id")
public @Nullable abstract String getClientId();
@SchemaFieldName("page")
public @Nullable abstract String getPage();
@SchemaFieldName("page_previous")
public @Nullable abstract String getPagePrevious();
@SchemaFieldName("ecommerce")
public @Nullable abstract Ecommerce getEcommerce();
public abstract Builder toBuilder();
public static Builder builder() {
return new AutoValue_ClickStream_ClickStreamEvent.Builder();
}
@AutoValue.Builder
public abstract static class Builder {
public abstract Builder setEventTime(String value);
public abstract Builder setEvent(String value);
public abstract Builder setTimestamp(Long value);
public abstract Builder setUid(Long value);
public abstract Builder setClientId(String value);
public abstract Builder setPage(String value);
public abstract Builder setPagePrevious(String value);
public abstract Builder setEcommerce(Ecommerce ecommerce);
public abstract ClickStreamEvent build();
}
}
// -----------------------------------
// Schema used for dealing with page views when working with BigTable.
// -----------------------------------
/** This class hosts the strings used for the row being stored in BigTable. */
public static class ClickStreamBigTableSchema {
public static final String PAGE_VIEW_AGGREGATION_COL_FAMILY = "pageViewAgg";
public static final String PAGE_VIEW_AGGREGATION_COL_PAGE_VIEW_REF = "pageViewRef";
public static final String PAGE_VIEW_AGGREGATION_COL_PAGE_VIEW_COUNT = "pageViewCount";
}
@AutoValue
@DefaultSchema(AutoValueSchema.class)
public abstract static class PageViewAggregator {
public @Nullable abstract Long getDurationMS();
public @Nullable abstract Long getStartTime();
public @Nullable abstract String getPage();
public @Nullable abstract Long getCount();
public abstract Builder toBuilder();
public static Builder builder() {
return new AutoValue_ClickStream_PageViewAggregator.Builder();
}
@AutoValue.Builder
public abstract static class Builder {
public abstract Builder setDurationMS(Long value);
public abstract Builder setStartTime(Long value);
public abstract Builder setPage(String value);
public abstract Builder setCount(Long value);
public abstract PageViewAggregator build();
}
}
}