xref: /aosp_15_r20/frameworks/proto_logging/stats/enums/adservices/measurement/enums.proto (revision 64c55175f22a2714b5ba1250098ad9bbc12ec7cd) 
1/*
2 * Copyright (C) 2023 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17syntax = "proto2";
18package android.adservices.service.measurement;
19
20option java_outer_classname = "MeasurementProtoEnums";
21option java_multiple_files = true;
22
23/**
24 * Enum used by AdServicesMeasurement(Registration, Attribution).
25 */
26enum SourceType {
27  UNKNOWN_SOURCE_TYPE = 0;
28  EVENT_SOURCE_TYPE = 1; // only deprecated for AdServicesMeasurementAttribution in favor of a VIEW_SOURCE_TYPE
29  NAVIGATION_SOURCE_TYPE = 2; // only deprecated for AdServicesMeasurementAttribution in favor of a CLICK_SOURCE_TYPE
30  VIEW_SOURCE_TYPE = 3;
31  CLICK_SOURCE_TYPE = 4;
32}
33
34/**
35 * Enum used by AdServicesMeasurementRegistration.
36 */
37enum RegistrationSurfaceType {
38  UNKNOWN_REGISTRATION_SURFACE_TYPE = 0;
39  WEB_REGISTRATION_SURFACE_TYPE = 1;
40  APP_REGISTRATION_SURFACE_TYPE = 2;
41}
42
43/**
44 * Enum used by AdServicesMeasurement(Registration, Attribution, Reporting,
45 * Jobs)
46 */
47enum Status {
48  UNKNOWN_STATUS = 0;
49  SUCCESS_STATUS = 1;
50  FAILURE_STATUS = 2;
51  AGGREGATE_REPORT_GENERATED_SUCCESS_STATUS = 3;
52  EVENT_REPORT_GENERATED_SUCCESS_STATUS = 4;
53  AGGREGATE_AND_EVENT_REPORTS_GENERATED_SUCCESS_STATUS = 5;
54  NULL_AGGREGATE_REPORT_GENERATED_SUCCESS_STATUS = 6;
55}
56
57/**
58 * Enum used by AdServicesMeasurementRegistration.
59 */
60enum RegistrationFailureType {
61  UNKNOWN_REGISTRATION_FAILURE_TYPE = 0;
62  PARSING_REGISTRATION_FAILURE_TYPE = 1;
63  NETWORK_REQUEST_REGISTRATION_FAILURE_TYPE = 2;
64  ENROLLMENT_REGISTRATION_FAILURE_TYPE = 3;
65  REDIRECT_REGISTRATION_FAILURE_TYPE = 4;
66  STORAGE_REGISTRATION_FAILURE_TYPE = 5;
67  JOB_RETRY_LIMIT_EXCEEDED_REGISTRATION_FAILURE_TYPE = 6;
68  HEADER_SIZE_LIMIT_EXCEEDED_FAILURE_TYPE  = 7;
69  SERVER_UNAVAILABLE_REGISTRATION_FAILURE_TYPE = 8;
70  INVALID_URL_REGISTRATION_FAILURE_TYPE = 9;
71}
72
73/**
74 * Enum used by AdServicesMeasurementReporting.
75 */
76enum ReportUploadFailureType {
77  UNKNOWN_REPORT_UPLOAD_FAILURE_TYPE = 0;
78  ENROLLMENT_NOT_FOUND_REPORT_UPLOAD_FAILURE_TYPE = 1;
79  NETWORK_ERROR_REPORT_UPLOAD_FAILURE_TYPE = 2;
80  DATASTORE_ERROR_REPORT_UPLOAD_FAILURE_TYPE = 3;
81  REPORT_NOT_PENDING_REPORT_UPLOAD_FAILURE_TYPE = 4;
82  JOB_RETRY_LIMIT_EXCEEDED_REPORT_UPLOAD_FAILURE_TYPE = 5;
83  SERIALIZATION_ERROR_REPORT_UPLOAD_FAILURE_TYPE = 6;
84  ENCRYPTION_ERROR_REPORT_UPLOAD_FAILURE_TYPE = 7;
85  UNSUCCESSFUL_HTTP_RESPONSE_CODE_FAILURE_TYPE = 8;
86  REPORT_NOT_FOUND_FAILURE_TYPE = 9;
87}
88
89/**
90 * Enum used by AdServicesMeasurementReporting.
91 */
92enum ReportUploadMethod {
93  UNKNOWN_REPORT_UPLOAD_METHOD = 0;
94  REGULAR_REPORT_UPLOAD_METHOD = 1;
95  FALLBACK_REPORT_UPLOAD_METHOD = 2;
96}
97
98/**
99 * Enum used by AdServicesMeasurementDelayedSourceRegistration.
100 */
101enum DelayedSourceRegistrationStatus {
102  UNKNOWN_DELAYED_SOURCE_REGISTRATION_STATUS = 0;
103  MISSING_DELAYED_SOURCE_REGISTRATION_STATUS = 1;
104  VALID_DELAYED_SOURCE_REGISTRATION_STATUS = 2;
105}
106
107/**
108 * Enum used by AdServicesMeasurementAttribution.
109 */
110enum AttributionSurfaceCombination {
111  UNKNOWN_ATTRIBUTION_SURFACE_COMBINATION = 0;
112  APP_APP_ATTRIBUTION_SURFACE_COMBINATION = 1;
113  APP_WEB_ATTRIBUTION_SURFACE_COMBINATION = 2;
114  WEB_APP_ATTRIBUTION_SURFACE_COMBINATION = 3;
115  WEB_WEB_ATTRIBUTION_SURFACE_COMBINATION = 4;
116}
117
118/**
119 * Enum used by AdServicesMeasurementAttribution.
120 */
121enum AttributionFailureType {
122  UNKNOWN_ATTRIBUTION_FAILURE_TYPE = 0;
123  TRIGGER_IGNORED_ATTRIBUTION_FAILURE_TYPE = 1;
124  TRIGGER_ALREADY_ATTRIBUTED_ATTRIBUTION_FAILURE_TYPE = 2;
125  TRIGGER_MARKED_FOR_DELETION_ATTRIBUTION_FAILURE_TYPE = 3;
126  NO_MATCHING_SOURCE_ATTRIBUTION_FAILURE_TYPE = 4;
127  NO_TOP_LEVEL_FILTER_MATCH_ATTRIBUTION_FAILURE_TYPE = 5;
128  RATE_LIMIT_EXCEEDED_ATTRIBUTION_FAILURE_TYPE = 6;
129  NO_REPORTS_GENERATED_ATTRIBUTION_FAILURE_TYPE = 7;
130  JOB_RETRY_LIMIT_EXCEEDED_ATTRIBUTION_FAILURE_TYPE = 8;
131  TRIGGER_NOT_FOUND_FAILURE_TYPE = 9;
132}
133
134/**
135 * Enum used by AdServicesMeasurementJobs.
136 */
137enum JobType {
138  UNKNOWN_JOB_TYPE = 0;
139  ASYNC_REGISTRATION_JOB_TYPE = 1;
140  ASYNC_REGISTRATION_FALLBACK_JOB_TYPE = 2;
141  ATTRIBUTION_JOB_TYPE = 3;
142  AGGREGATION_REPORTING_JOB_TYPE = 4;
143  AGGREGATE_REPORTING_FALLBACK_JOB_TYPE = 5;
144  EVENT_REPORTING_JOB_TYPE = 6;
145  EVENT_REPORTING_FALLBACK_JOB_TYPE = 7;
146  DELETE_EXPIRED_JOB_TYPE = 8;
147  DELETE_UNINSTALLED_JOB_TYPE = 9;
148}
149
150/**
151 * Enum used by AdServicesMeasurementWipeout.
152 */
153enum WipeoutCause {
154  UNKNOWN_WIPEOUT_CAUSE = 0;
155  UNINSTALL_WIPEOUT_CAUSE = 1;
156  CONSENT_FLIP_WIPEOUT_CAUSE = 2;
157  CLEAR_DATA_WIPEOUT_CAUSE = 3;
158  DELETE_REGISTRATIONS_API_CLEAR_DATA_WIPEOUT_CAUSE = 4;
159  PACKAGE_CHANGED_WIPEOUT_CAUSE = 5;
160  ROLLBACK_WIPEOUT_CAUSE = 6;
161}
162
163/**
164 * Enum used by AdServicesMeasurementProcessOdpRegistration.
165 */
166enum OdpRegistrationType {
167  UNKNOWN_ODP_REGISTRATION_TYPE = 0;
168  TRIGGER_ODP_REGISTRATION_TYPE = 1;
169}
170
171/**
172 * Enum used by AdServicesMeasurementProcessOdpRegistration.
173 */
174enum OdpRegistrationStatus {
175  UNKNOWN_ODP_REGISTRATION_STATUS = 0;
176  SUCCESS_ODP_REGISTRATION_STATUS = 1;
177  ODP_UNAVAILABLE_REGISTRATION_STATUS = 2;
178  INVALID_HEADER_FORMAT_ODP_REGISTRATION_STATUS = 3;
179  MISSING_REQUIRED_HEADER_FIELD_ODP_REGISTRATION_STATUS = 4;
180  INVALID_HEADER_FIELD_VALUE_ODP_REGISTRATION_STATUS = 5;
181  INVALID_ENROLLMENT_ODP_REGISTRATION_STATUS = 6;
182  HEADER_SIZE_LIMIT_EXCEEDED_ODP_REGISTRATION_STATUS = 7;
183  PARSING_EXCEPTION_ODP_REGISTRATION_STATUS = 8;
184}
185
186/**
187 * Enum used by AdServicesMeasurementNotifyRegistrationToOdp.
188 */
189enum OdpApiCallStatus {
190  UNKNOWN_ODP_API_CALL_STATUS = 0;
191  SUCCESS_ODP_API_CALL_STATUS = 1;
192  FAILED_ODP_API_CALL_STATUS = 2;
193}