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
|
/*
* Copyright (C) 2022 The Android Open Source Project
*
* Licensed 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.android.adservices.service.measurement;
import com.android.adservices.service.measurement.util.Validation;
import java.util.Objects;
/**
* It is used to insert and retrieve an entry in the database that counts towards attribution rate
* limits. It is typically built from an {@link EventReport} or {@link Source}-{@link Trigger}
* combination.
*/
public class Attribution {
private final String mId;
private final String mSourceSite;
private final String mSourceOrigin;
private final String mDestinationSite;
private final String mDestinationOrigin;
private final String mEnrollmentId;
private final long mTriggerTime;
private final String mRegistrant;
private final String mSourceId;
private final String mTriggerId;
private Attribution(Builder builder) {
this.mId = builder.mId;
this.mSourceSite = builder.mSourceSite;
this.mSourceOrigin = builder.mSourceOrigin;
this.mDestinationSite = builder.mDestinationSite;
this.mDestinationOrigin = builder.mDestinationOrigin;
this.mEnrollmentId = builder.mEnrollmentId;
this.mTriggerTime = builder.mTriggerTime;
this.mRegistrant = builder.mRegistrant;
this.mSourceId = builder.mSourceId;
this.mTriggerId = builder.mTriggerId;
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof Attribution)) {
return false;
}
Attribution attr = (Attribution) obj;
return mTriggerTime == attr.mTriggerTime
&& Objects.equals(mSourceSite, attr.mSourceSite)
&& Objects.equals(mSourceOrigin, attr.mSourceOrigin)
&& Objects.equals(mDestinationSite, attr.mDestinationSite)
&& Objects.equals(mDestinationOrigin, attr.mDestinationOrigin)
&& Objects.equals(mEnrollmentId, attr.mEnrollmentId)
&& Objects.equals(mRegistrant, attr.mRegistrant)
&& Objects.equals(mSourceId, attr.mSourceId)
&& Objects.equals(mTriggerId, attr.mTriggerId);
}
@Override
public int hashCode() {
return Objects.hash(
mSourceSite,
mSourceOrigin,
mDestinationSite,
mDestinationOrigin,
mEnrollmentId,
mTriggerTime,
mRegistrant,
mSourceId,
mTriggerId);
}
/** @return unique identifier for {@link Attribution} */
public String getId() {
return mId;
}
/** @return top private domain of {@link Source} publisher */
public String getSourceSite() {
return mSourceSite;
}
/** @return complete {@link Source} publisher */
public String getSourceOrigin() {
return mSourceOrigin;
}
/** @return top private domain of {@link Trigger} destination */
public String getDestinationSite() {
return mDestinationSite;
}
/** @return complete {@link Trigger} destination */
public String getDestinationOrigin() {
return mDestinationOrigin;
}
/** @return {@link Source} or {@link Trigger} enrollment ID */
public String getEnrollmentId() {
return mEnrollmentId;
}
/** @return {@link Trigger} event time */
public long getTriggerTime() {
return mTriggerTime;
}
/** @return {@link Trigger} registrant */
public String getRegistrant() {
return mRegistrant;
}
/** @return {@link Source} ID */
public String getSourceId() {
return mSourceId;
}
/** @return {@link Trigger} ID */
public String getTriggerId() {
return mTriggerId;
}
/** Builder for AttributionRateLimit */
public static final class Builder {
private String mId;
private String mSourceSite;
private String mSourceOrigin;
private String mDestinationSite;
private String mDestinationOrigin;
private String mEnrollmentId;
private long mTriggerTime;
private String mRegistrant;
private String mSourceId;
private String mTriggerId;
/** See {@link Attribution#getId()}. */
public Builder setId(String id) {
mId = id;
return this;
}
/** See {@link Attribution#getSourceSite()}. */
public Builder setSourceSite(String sourceSite) {
mSourceSite = sourceSite;
return this;
}
/** See {@link Attribution#getSourceOrigin()}. */
public Builder setSourceOrigin(String sourceOrigin) {
mSourceOrigin = sourceOrigin;
return this;
}
/** See {@link Attribution#getDestinationSite()}. */
public Builder setDestinationSite(String destinationSite) {
mDestinationSite = destinationSite;
return this;
}
/** See {@link Attribution#getDestinationOrigin()}. */
public Builder setDestinationOrigin(String destinationOrigin) {
mDestinationOrigin = destinationOrigin;
return this;
}
/** See {@link Attribution#getEnrollmentId()}. */
public Builder setEnrollmentId(String enrollmentId) {
mEnrollmentId = enrollmentId;
return this;
}
/** See {@link Attribution#getTriggerTime()}. */
public Builder setTriggerTime(long triggerTime) {
mTriggerTime = triggerTime;
return this;
}
/** See {@link Attribution#getRegistrant()}. */
public Builder setRegistrant(String registrant) {
mRegistrant = registrant;
return this;
}
/** See {@link Attribution#getSourceId()}. */
public Builder setSourceId(String sourceId) {
mSourceId = sourceId;
return this;
}
/** See {@link Attribution#getTriggerId()}. */
public Builder setTriggerId(String triggerId) {
mTriggerId = triggerId;
return this;
}
/** Validate and build the {@link Attribution}. */
public Attribution build() {
Validation.validateNonNull(
mSourceSite,
mSourceOrigin,
mDestinationSite,
mDestinationOrigin,
mEnrollmentId,
mRegistrant);
return new Attribution(this);
}
}
}
|
