xref: /aosp_15_r20/prebuilts/sdk/extensions/10/public/api/framework-adservices.txt (revision 344a7f5ef16c479e7a7f54ee6567a9d112f9e72b) 
1// Signature format: 2.0
2package android.adservices {
3
4  public class AdServicesState {
5    method public static boolean isAdServicesStateEnabled();
6  }
7
8}
9
10package android.adservices.adid {
11
12  public class AdId {
13    ctor public AdId(@NonNull String, boolean);
14    method @NonNull public String getAdId();
15    method public boolean isLimitAdTrackingEnabled();
16    field public static final String ZERO_OUT = "00000000-0000-0000-0000-000000000000";
17  }
18
19  public class AdIdManager {
20    method @NonNull public static android.adservices.adid.AdIdManager get(@NonNull android.content.Context);
21    method @NonNull @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_AD_ID) public void getAdId(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<android.adservices.adid.AdId,java.lang.Exception>);
22  }
23
24}
25
26package android.adservices.adselection {
27
28  public final class AdSelectionConfig implements android.os.Parcelable {
29    method public int describeContents();
30    method @NonNull public android.adservices.common.AdSelectionSignals getAdSelectionSignals();
31    method @NonNull public java.util.List<android.adservices.common.AdTechIdentifier> getCustomAudienceBuyers();
32    method @NonNull public android.net.Uri getDecisionLogicUri();
33    method @NonNull public java.util.Map<android.adservices.common.AdTechIdentifier,android.adservices.common.AdSelectionSignals> getPerBuyerSignals();
34    method @NonNull public android.adservices.common.AdTechIdentifier getSeller();
35    method @NonNull public android.adservices.common.AdSelectionSignals getSellerSignals();
36    method @NonNull public android.net.Uri getTrustedScoringSignalsUri();
37    method public void writeToParcel(@NonNull android.os.Parcel, int);
38    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.adselection.AdSelectionConfig> CREATOR;
39  }
40
41  public static final class AdSelectionConfig.Builder {
42    ctor public AdSelectionConfig.Builder();
43    method @NonNull public android.adservices.adselection.AdSelectionConfig build();
44    method @NonNull public android.adservices.adselection.AdSelectionConfig.Builder setAdSelectionSignals(@NonNull android.adservices.common.AdSelectionSignals);
45    method @NonNull public android.adservices.adselection.AdSelectionConfig.Builder setCustomAudienceBuyers(@NonNull java.util.List<android.adservices.common.AdTechIdentifier>);
46    method @NonNull public android.adservices.adselection.AdSelectionConfig.Builder setDecisionLogicUri(@NonNull android.net.Uri);
47    method @NonNull public android.adservices.adselection.AdSelectionConfig.Builder setPerBuyerSignals(@NonNull java.util.Map<android.adservices.common.AdTechIdentifier,android.adservices.common.AdSelectionSignals>);
48    method @NonNull public android.adservices.adselection.AdSelectionConfig.Builder setSeller(@NonNull android.adservices.common.AdTechIdentifier);
49    method @NonNull public android.adservices.adselection.AdSelectionConfig.Builder setSellerSignals(@NonNull android.adservices.common.AdSelectionSignals);
50    method @NonNull public android.adservices.adselection.AdSelectionConfig.Builder setTrustedScoringSignalsUri(@NonNull android.net.Uri);
51  }
52
53  public final class AdSelectionFromOutcomesConfig implements android.os.Parcelable {
54    method public int describeContents();
55    method @NonNull public java.util.List<java.lang.Long> getAdSelectionIds();
56    method @NonNull public android.net.Uri getSelectionLogicUri();
57    method @NonNull public android.adservices.common.AdSelectionSignals getSelectionSignals();
58    method @NonNull public android.adservices.common.AdTechIdentifier getSeller();
59    method public void writeToParcel(@NonNull android.os.Parcel, int);
60    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.adselection.AdSelectionFromOutcomesConfig> CREATOR;
61  }
62
63  public static final class AdSelectionFromOutcomesConfig.Builder {
64    ctor public AdSelectionFromOutcomesConfig.Builder();
65    method @NonNull public android.adservices.adselection.AdSelectionFromOutcomesConfig build();
66    method @NonNull public android.adservices.adselection.AdSelectionFromOutcomesConfig.Builder setAdSelectionIds(@NonNull java.util.List<java.lang.Long>);
67    method @NonNull public android.adservices.adselection.AdSelectionFromOutcomesConfig.Builder setSelectionLogicUri(@NonNull android.net.Uri);
68    method @NonNull public android.adservices.adselection.AdSelectionFromOutcomesConfig.Builder setSelectionSignals(@NonNull android.adservices.common.AdSelectionSignals);
69    method @NonNull public android.adservices.adselection.AdSelectionFromOutcomesConfig.Builder setSeller(@NonNull android.adservices.common.AdTechIdentifier);
70  }
71
72  public class AdSelectionManager {
73    method @NonNull public static android.adservices.adselection.AdSelectionManager get(@NonNull android.content.Context);
74    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void getAdSelectionData(@NonNull android.adservices.adselection.GetAdSelectionDataRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<android.adservices.adselection.GetAdSelectionDataOutcome,java.lang.Exception>);
75    method @NonNull public android.adservices.adselection.TestAdSelectionManager getTestAdSelectionManager();
76    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void persistAdSelectionResult(@NonNull android.adservices.adselection.PersistAdSelectionResultRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<android.adservices.adselection.AdSelectionOutcome,java.lang.Exception>);
77    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void reportEvent(@NonNull android.adservices.adselection.ReportEventRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
78    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void reportImpression(@NonNull android.adservices.adselection.ReportImpressionRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
79    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void selectAds(@NonNull android.adservices.adselection.AdSelectionConfig, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<android.adservices.adselection.AdSelectionOutcome,java.lang.Exception>);
80    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void selectAds(@NonNull android.adservices.adselection.AdSelectionFromOutcomesConfig, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<android.adservices.adselection.AdSelectionOutcome,java.lang.Exception>);
81    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void updateAdCounterHistogram(@NonNull android.adservices.adselection.UpdateAdCounterHistogramRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
82  }
83
84  public class AdSelectionOutcome {
85    method @NonNull public long getAdSelectionId();
86    method @NonNull public android.net.Uri getRenderUri();
87    method public boolean hasOutcome();
88    field @NonNull public static final android.adservices.adselection.AdSelectionOutcome NO_OUTCOME;
89  }
90
91  public static final class AdSelectionOutcome.Builder {
92    ctor public AdSelectionOutcome.Builder();
93    method @NonNull public android.adservices.adselection.AdSelectionOutcome build();
94    method @NonNull public android.adservices.adselection.AdSelectionOutcome.Builder setAdSelectionId(long);
95    method @NonNull public android.adservices.adselection.AdSelectionOutcome.Builder setRenderUri(@NonNull android.net.Uri);
96  }
97
98  public class AddAdSelectionFromOutcomesOverrideRequest {
99    ctor public AddAdSelectionFromOutcomesOverrideRequest(@NonNull android.adservices.adselection.AdSelectionFromOutcomesConfig, @NonNull String, @NonNull android.adservices.common.AdSelectionSignals);
100    method @NonNull public android.adservices.adselection.AdSelectionFromOutcomesConfig getAdSelectionFromOutcomesConfig();
101    method @NonNull public String getOutcomeSelectionLogicJs();
102    method @NonNull public android.adservices.common.AdSelectionSignals getOutcomeSelectionTrustedSignals();
103  }
104
105  public class AddAdSelectionOverrideRequest {
106    ctor public AddAdSelectionOverrideRequest(@NonNull android.adservices.adselection.AdSelectionConfig, @NonNull String, @NonNull android.adservices.common.AdSelectionSignals);
107    method @NonNull public android.adservices.adselection.AdSelectionConfig getAdSelectionConfig();
108    method @NonNull public String getDecisionLogicJs();
109    method @NonNull public android.adservices.common.AdSelectionSignals getTrustedScoringSignals();
110  }
111
112  public final class GetAdSelectionDataOutcome {
113    method @Nullable public byte[] getAdSelectionData();
114    method public long getAdSelectionId();
115  }
116
117  public final class GetAdSelectionDataRequest {
118    method @Nullable public android.adservices.common.AdTechIdentifier getSeller();
119  }
120
121  public static final class GetAdSelectionDataRequest.Builder {
122    ctor public GetAdSelectionDataRequest.Builder();
123    method @NonNull public android.adservices.adselection.GetAdSelectionDataRequest build();
124    method @NonNull public android.adservices.adselection.GetAdSelectionDataRequest.Builder setSeller(@Nullable android.adservices.common.AdTechIdentifier);
125  }
126
127  public final class PersistAdSelectionResultRequest {
128    method public long getAdSelectionId();
129    method @Nullable public byte[] getAdSelectionResult();
130    method @Nullable public android.adservices.common.AdTechIdentifier getSeller();
131  }
132
133  public static final class PersistAdSelectionResultRequest.Builder {
134    ctor public PersistAdSelectionResultRequest.Builder();
135    method @NonNull public android.adservices.adselection.PersistAdSelectionResultRequest build();
136    method @NonNull public android.adservices.adselection.PersistAdSelectionResultRequest.Builder setAdSelectionId(long);
137    method @NonNull public android.adservices.adselection.PersistAdSelectionResultRequest.Builder setAdSelectionResult(@Nullable byte[]);
138    method @NonNull public android.adservices.adselection.PersistAdSelectionResultRequest.Builder setSeller(@Nullable android.adservices.common.AdTechIdentifier);
139  }
140
141  public class RemoveAdSelectionFromOutcomesOverrideRequest {
142    ctor public RemoveAdSelectionFromOutcomesOverrideRequest(@NonNull android.adservices.adselection.AdSelectionFromOutcomesConfig);
143    method @NonNull public android.adservices.adselection.AdSelectionFromOutcomesConfig getAdSelectionFromOutcomesConfig();
144  }
145
146  public class RemoveAdSelectionOverrideRequest {
147    ctor public RemoveAdSelectionOverrideRequest(@NonNull android.adservices.adselection.AdSelectionConfig);
148    method @NonNull public android.adservices.adselection.AdSelectionConfig getAdSelectionConfig();
149  }
150
151  public class ReportEventRequest {
152    method public long getAdSelectionId();
153    method @NonNull public String getData();
154    method @Nullable public android.view.InputEvent getInputEvent();
155    method @NonNull public String getKey();
156    method public int getReportingDestinations();
157    field public static final int FLAG_REPORTING_DESTINATION_BUYER = 2; // 0x2
158    field public static final int FLAG_REPORTING_DESTINATION_SELLER = 1; // 0x1
159  }
160
161  public static final class ReportEventRequest.Builder {
162    ctor public ReportEventRequest.Builder(long, @NonNull String, @NonNull String, int);
163    method @NonNull public android.adservices.adselection.ReportEventRequest build();
164    method @NonNull public android.adservices.adselection.ReportEventRequest.Builder setAdSelectionId(long);
165    method @NonNull public android.adservices.adselection.ReportEventRequest.Builder setData(@NonNull String);
166    method @NonNull public android.adservices.adselection.ReportEventRequest.Builder setInputEvent(@Nullable android.view.InputEvent);
167    method @NonNull public android.adservices.adselection.ReportEventRequest.Builder setKey(@NonNull String);
168    method @NonNull public android.adservices.adselection.ReportEventRequest.Builder setReportingDestinations(int);
169  }
170
171  public class ReportImpressionRequest {
172    ctor public ReportImpressionRequest(long, @NonNull android.adservices.adselection.AdSelectionConfig);
173    ctor public ReportImpressionRequest(long);
174    method @NonNull public android.adservices.adselection.AdSelectionConfig getAdSelectionConfig();
175    method public long getAdSelectionId();
176  }
177
178  public class TestAdSelectionManager {
179    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void overrideAdSelectionConfigRemoteInfo(@NonNull android.adservices.adselection.AddAdSelectionOverrideRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
180    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void overrideAdSelectionFromOutcomesConfigRemoteInfo(@NonNull android.adservices.adselection.AddAdSelectionFromOutcomesOverrideRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
181    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void removeAdSelectionConfigRemoteInfoOverride(@NonNull android.adservices.adselection.RemoveAdSelectionOverrideRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
182    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void removeAdSelectionFromOutcomesConfigRemoteInfoOverride(@NonNull android.adservices.adselection.RemoveAdSelectionFromOutcomesOverrideRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
183    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void resetAllAdSelectionConfigRemoteOverrides(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
184    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void resetAllAdSelectionFromOutcomesConfigRemoteOverrides(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
185  }
186
187  public class UpdateAdCounterHistogramRequest {
188    method public int getAdEventType();
189    method public long getAdSelectionId();
190    method @NonNull public android.adservices.common.AdTechIdentifier getCallerAdTech();
191  }
192
193  public static final class UpdateAdCounterHistogramRequest.Builder {
194    ctor public UpdateAdCounterHistogramRequest.Builder(long, int, @NonNull android.adservices.common.AdTechIdentifier);
195    method @NonNull public android.adservices.adselection.UpdateAdCounterHistogramRequest build();
196    method @NonNull public android.adservices.adselection.UpdateAdCounterHistogramRequest.Builder setAdEventType(int);
197    method @NonNull public android.adservices.adselection.UpdateAdCounterHistogramRequest.Builder setAdSelectionId(long);
198    method @NonNull public android.adservices.adselection.UpdateAdCounterHistogramRequest.Builder setCallerAdTech(@NonNull android.adservices.common.AdTechIdentifier);
199  }
200
201}
202
203package android.adservices.appsetid {
204
205  public class AppSetId {
206    ctor public AppSetId(@NonNull String, int);
207    method @NonNull public String getId();
208    method public int getScope();
209    field public static final int SCOPE_APP = 1; // 0x1
210    field public static final int SCOPE_DEVELOPER = 2; // 0x2
211  }
212
213  public class AppSetIdManager {
214    method @NonNull public static android.adservices.appsetid.AppSetIdManager get(@NonNull android.content.Context);
215    method @NonNull public void getAppSetId(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<android.adservices.appsetid.AppSetId,java.lang.Exception>);
216  }
217
218}
219
220package android.adservices.common {
221
222  public final class AdData implements android.os.Parcelable {
223    method public int describeContents();
224    method @NonNull public java.util.Set<java.lang.Integer> getAdCounterKeys();
225    method @Nullable public android.adservices.common.AdFilters getAdFilters();
226    method @Nullable public String getAdRenderId();
227    method @NonNull public String getMetadata();
228    method @NonNull public android.net.Uri getRenderUri();
229    method public void writeToParcel(@NonNull android.os.Parcel, int);
230    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.common.AdData> CREATOR;
231  }
232
233  public static final class AdData.Builder {
234    ctor public AdData.Builder();
235    method @NonNull public android.adservices.common.AdData build();
236    method @NonNull public android.adservices.common.AdData.Builder setAdCounterKeys(@NonNull java.util.Set<java.lang.Integer>);
237    method @NonNull public android.adservices.common.AdData.Builder setAdFilters(@Nullable android.adservices.common.AdFilters);
238    method @NonNull public android.adservices.common.AdData.Builder setAdRenderId(@Nullable String);
239    method @NonNull public android.adservices.common.AdData.Builder setMetadata(@NonNull String);
240    method @NonNull public android.adservices.common.AdData.Builder setRenderUri(@NonNull android.net.Uri);
241  }
242
243  public final class AdFilters implements android.os.Parcelable {
244    method public int describeContents();
245    method @Nullable public android.adservices.common.FrequencyCapFilters getFrequencyCapFilters();
246    method public void writeToParcel(@NonNull android.os.Parcel, int);
247    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.common.AdFilters> CREATOR;
248  }
249
250  public static final class AdFilters.Builder {
251    ctor public AdFilters.Builder();
252    method @NonNull public android.adservices.common.AdFilters build();
253    method @NonNull public android.adservices.common.AdFilters.Builder setFrequencyCapFilters(@Nullable android.adservices.common.FrequencyCapFilters);
254  }
255
256  public final class AdSelectionSignals implements android.os.Parcelable {
257    method public int describeContents();
258    method @NonNull public static android.adservices.common.AdSelectionSignals fromString(@NonNull String);
259    method public void writeToParcel(@NonNull android.os.Parcel, int);
260    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.common.AdSelectionSignals> CREATOR;
261    field public static final android.adservices.common.AdSelectionSignals EMPTY;
262  }
263
264  public interface AdServicesOutcomeReceiver<R, E extends java.lang.Throwable> {
265    method public default void onError(@NonNull E);
266    method public void onResult(R);
267  }
268
269  public class AdServicesPermissions {
270    field public static final String ACCESS_ADSERVICES_AD_ID = "android.permission.ACCESS_ADSERVICES_AD_ID";
271    field public static final String ACCESS_ADSERVICES_ATTRIBUTION = "android.permission.ACCESS_ADSERVICES_ATTRIBUTION";
272    field public static final String ACCESS_ADSERVICES_CUSTOM_AUDIENCE = "android.permission.ACCESS_ADSERVICES_CUSTOM_AUDIENCE";
273    field public static final String ACCESS_ADSERVICES_TOPICS = "android.permission.ACCESS_ADSERVICES_TOPICS";
274  }
275
276  public final class AdTechIdentifier implements android.os.Parcelable {
277    method public int describeContents();
278    method @NonNull public static android.adservices.common.AdTechIdentifier fromString(@NonNull String);
279    method public void writeToParcel(@NonNull android.os.Parcel, int);
280    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.common.AdTechIdentifier> CREATOR;
281  }
282
283  public final class FrequencyCapFilters implements android.os.Parcelable {
284    method public int describeContents();
285    method @NonNull public java.util.List<android.adservices.common.KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents();
286    method @NonNull public java.util.List<android.adservices.common.KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents();
287    method @NonNull public java.util.List<android.adservices.common.KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents();
288    method @NonNull public java.util.List<android.adservices.common.KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents();
289    method public void writeToParcel(@NonNull android.os.Parcel, int);
290    field public static final int AD_EVENT_TYPE_CLICK = 3; // 0x3
291    field public static final int AD_EVENT_TYPE_IMPRESSION = 1; // 0x1
292    field public static final int AD_EVENT_TYPE_VIEW = 2; // 0x2
293    field public static final int AD_EVENT_TYPE_WIN = 0; // 0x0
294    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.common.FrequencyCapFilters> CREATOR;
295  }
296
297  public static final class FrequencyCapFilters.Builder {
298    ctor public FrequencyCapFilters.Builder();
299    method @NonNull public android.adservices.common.FrequencyCapFilters build();
300    method @NonNull public android.adservices.common.FrequencyCapFilters.Builder setKeyedFrequencyCapsForClickEvents(@NonNull java.util.List<android.adservices.common.KeyedFrequencyCap>);
301    method @NonNull public android.adservices.common.FrequencyCapFilters.Builder setKeyedFrequencyCapsForImpressionEvents(@NonNull java.util.List<android.adservices.common.KeyedFrequencyCap>);
302    method @NonNull public android.adservices.common.FrequencyCapFilters.Builder setKeyedFrequencyCapsForViewEvents(@NonNull java.util.List<android.adservices.common.KeyedFrequencyCap>);
303    method @NonNull public android.adservices.common.FrequencyCapFilters.Builder setKeyedFrequencyCapsForWinEvents(@NonNull java.util.List<android.adservices.common.KeyedFrequencyCap>);
304  }
305
306  public final class KeyedFrequencyCap implements android.os.Parcelable {
307    method public int describeContents();
308    method @NonNull public int getAdCounterKey();
309    method @NonNull public java.time.Duration getInterval();
310    method public int getMaxCount();
311    method public void writeToParcel(@NonNull android.os.Parcel, int);
312    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.common.KeyedFrequencyCap> CREATOR;
313  }
314
315  public static final class KeyedFrequencyCap.Builder {
316    ctor public KeyedFrequencyCap.Builder(int, int, @NonNull java.time.Duration);
317    method @NonNull public android.adservices.common.KeyedFrequencyCap build();
318    method @NonNull public android.adservices.common.KeyedFrequencyCap.Builder setAdCounterKey(int);
319    method @NonNull public android.adservices.common.KeyedFrequencyCap.Builder setInterval(@NonNull java.time.Duration);
320    method @NonNull public android.adservices.common.KeyedFrequencyCap.Builder setMaxCount(int);
321  }
322
323}
324
325package android.adservices.customaudience {
326
327  public class AddCustomAudienceOverrideRequest {
328    ctor public AddCustomAudienceOverrideRequest(@NonNull android.adservices.common.AdTechIdentifier, @NonNull String, @NonNull String, @NonNull android.adservices.common.AdSelectionSignals);
329    method @NonNull public String getBiddingLogicJs();
330    method @NonNull public android.adservices.common.AdTechIdentifier getBuyer();
331    method @NonNull public String getName();
332    method @NonNull public android.adservices.common.AdSelectionSignals getTrustedBiddingSignals();
333  }
334
335  public static final class AddCustomAudienceOverrideRequest.Builder {
336    ctor public AddCustomAudienceOverrideRequest.Builder();
337    method @NonNull public android.adservices.customaudience.AddCustomAudienceOverrideRequest build();
338    method @NonNull public android.adservices.customaudience.AddCustomAudienceOverrideRequest.Builder setBiddingLogicJs(@NonNull String);
339    method @NonNull public android.adservices.customaudience.AddCustomAudienceOverrideRequest.Builder setBuyer(@NonNull android.adservices.common.AdTechIdentifier);
340    method @NonNull public android.adservices.customaudience.AddCustomAudienceOverrideRequest.Builder setName(@NonNull String);
341    method @NonNull public android.adservices.customaudience.AddCustomAudienceOverrideRequest.Builder setTrustedBiddingSignals(@NonNull android.adservices.common.AdSelectionSignals);
342  }
343
344  public final class CustomAudience implements android.os.Parcelable {
345    method public int describeContents();
346    method @Nullable public java.time.Instant getActivationTime();
347    method @NonNull public java.util.List<android.adservices.common.AdData> getAds();
348    method @NonNull public android.net.Uri getBiddingLogicUri();
349    method @NonNull public android.adservices.common.AdTechIdentifier getBuyer();
350    method @NonNull public android.net.Uri getDailyUpdateUri();
351    method @Nullable public java.time.Instant getExpirationTime();
352    method @NonNull public String getName();
353    method @Nullable public android.adservices.customaudience.TrustedBiddingData getTrustedBiddingData();
354    method @Nullable public android.adservices.common.AdSelectionSignals getUserBiddingSignals();
355    method public void writeToParcel(@NonNull android.os.Parcel, int);
356    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.customaudience.CustomAudience> CREATOR;
357  }
358
359  public static final class CustomAudience.Builder {
360    ctor public CustomAudience.Builder();
361    method @NonNull public android.adservices.customaudience.CustomAudience build();
362    method @NonNull public android.adservices.customaudience.CustomAudience.Builder setActivationTime(@Nullable java.time.Instant);
363    method @NonNull public android.adservices.customaudience.CustomAudience.Builder setAds(@Nullable java.util.List<android.adservices.common.AdData>);
364    method @NonNull public android.adservices.customaudience.CustomAudience.Builder setBiddingLogicUri(@NonNull android.net.Uri);
365    method @NonNull public android.adservices.customaudience.CustomAudience.Builder setBuyer(@NonNull android.adservices.common.AdTechIdentifier);
366    method @NonNull public android.adservices.customaudience.CustomAudience.Builder setDailyUpdateUri(@NonNull android.net.Uri);
367    method @NonNull public android.adservices.customaudience.CustomAudience.Builder setExpirationTime(@Nullable java.time.Instant);
368    method @NonNull public android.adservices.customaudience.CustomAudience.Builder setName(@NonNull String);
369    method @NonNull public android.adservices.customaudience.CustomAudience.Builder setTrustedBiddingData(@Nullable android.adservices.customaudience.TrustedBiddingData);
370    method @NonNull public android.adservices.customaudience.CustomAudience.Builder setUserBiddingSignals(@Nullable android.adservices.common.AdSelectionSignals);
371  }
372
373  public class CustomAudienceManager {
374    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void fetchAndJoinCustomAudience(@NonNull android.adservices.customaudience.FetchAndJoinCustomAudienceRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
375    method @NonNull public static android.adservices.customaudience.CustomAudienceManager get(@NonNull android.content.Context);
376    method @NonNull public android.adservices.customaudience.TestCustomAudienceManager getTestCustomAudienceManager();
377    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void joinCustomAudience(@NonNull android.adservices.customaudience.JoinCustomAudienceRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
378    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void leaveCustomAudience(@NonNull android.adservices.customaudience.LeaveCustomAudienceRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
379  }
380
381  public final class FetchAndJoinCustomAudienceRequest {
382    method @Nullable public java.time.Instant getActivationTime();
383    method @Nullable public java.time.Instant getExpirationTime();
384    method @NonNull public android.net.Uri getFetchUri();
385    method @Nullable public String getName();
386    method @Nullable public android.adservices.common.AdSelectionSignals getUserBiddingSignals();
387  }
388
389  public static final class FetchAndJoinCustomAudienceRequest.Builder {
390    ctor public FetchAndJoinCustomAudienceRequest.Builder(@NonNull android.net.Uri);
391    method @NonNull public android.adservices.customaudience.FetchAndJoinCustomAudienceRequest build();
392    method @NonNull public android.adservices.customaudience.FetchAndJoinCustomAudienceRequest.Builder setActivationTime(@Nullable java.time.Instant);
393    method @NonNull public android.adservices.customaudience.FetchAndJoinCustomAudienceRequest.Builder setExpirationTime(@Nullable java.time.Instant);
394    method @NonNull public android.adservices.customaudience.FetchAndJoinCustomAudienceRequest.Builder setFetchUri(@NonNull android.net.Uri);
395    method @NonNull public android.adservices.customaudience.FetchAndJoinCustomAudienceRequest.Builder setName(@Nullable String);
396    method @NonNull public android.adservices.customaudience.FetchAndJoinCustomAudienceRequest.Builder setUserBiddingSignals(@Nullable android.adservices.common.AdSelectionSignals);
397  }
398
399  public class JoinCustomAudienceRequest {
400    method @NonNull public android.adservices.customaudience.CustomAudience getCustomAudience();
401  }
402
403  public static final class JoinCustomAudienceRequest.Builder {
404    ctor public JoinCustomAudienceRequest.Builder();
405    method @NonNull public android.adservices.customaudience.JoinCustomAudienceRequest build();
406    method @NonNull public android.adservices.customaudience.JoinCustomAudienceRequest.Builder setCustomAudience(@NonNull android.adservices.customaudience.CustomAudience);
407  }
408
409  public final class LeaveCustomAudienceRequest {
410    method @NonNull public android.adservices.common.AdTechIdentifier getBuyer();
411    method @NonNull public String getName();
412  }
413
414  public static final class LeaveCustomAudienceRequest.Builder {
415    ctor public LeaveCustomAudienceRequest.Builder();
416    method @NonNull public android.adservices.customaudience.LeaveCustomAudienceRequest build();
417    method @NonNull public android.adservices.customaudience.LeaveCustomAudienceRequest.Builder setBuyer(@NonNull android.adservices.common.AdTechIdentifier);
418    method @NonNull public android.adservices.customaudience.LeaveCustomAudienceRequest.Builder setName(@NonNull String);
419  }
420
421  public class RemoveCustomAudienceOverrideRequest {
422    ctor public RemoveCustomAudienceOverrideRequest(@NonNull android.adservices.common.AdTechIdentifier, @NonNull String);
423    method @NonNull public android.adservices.common.AdTechIdentifier getBuyer();
424    method @NonNull public String getName();
425  }
426
427  public static final class RemoveCustomAudienceOverrideRequest.Builder {
428    ctor public RemoveCustomAudienceOverrideRequest.Builder();
429    method @NonNull public android.adservices.customaudience.RemoveCustomAudienceOverrideRequest build();
430    method @NonNull public android.adservices.customaudience.RemoveCustomAudienceOverrideRequest.Builder setBuyer(@NonNull android.adservices.common.AdTechIdentifier);
431    method @NonNull public android.adservices.customaudience.RemoveCustomAudienceOverrideRequest.Builder setName(@NonNull String);
432  }
433
434  public class TestCustomAudienceManager {
435    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void overrideCustomAudienceRemoteInfo(@NonNull android.adservices.customaudience.AddCustomAudienceOverrideRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
436    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void removeCustomAudienceRemoteInfoOverride(@NonNull android.adservices.customaudience.RemoveCustomAudienceOverrideRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
437    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE) public void resetAllCustomAudienceOverrides(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
438  }
439
440  public final class TrustedBiddingData implements android.os.Parcelable {
441    method public int describeContents();
442    method @NonNull public java.util.List<java.lang.String> getTrustedBiddingKeys();
443    method @NonNull public android.net.Uri getTrustedBiddingUri();
444    method public void writeToParcel(@NonNull android.os.Parcel, int);
445    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.customaudience.TrustedBiddingData> CREATOR;
446  }
447
448  public static final class TrustedBiddingData.Builder {
449    ctor public TrustedBiddingData.Builder();
450    method @NonNull public android.adservices.customaudience.TrustedBiddingData build();
451    method @NonNull public android.adservices.customaudience.TrustedBiddingData.Builder setTrustedBiddingKeys(@NonNull java.util.List<java.lang.String>);
452    method @NonNull public android.adservices.customaudience.TrustedBiddingData.Builder setTrustedBiddingUri(@NonNull android.net.Uri);
453  }
454
455}
456
457package android.adservices.exceptions {
458
459  public class AdServicesException extends java.lang.Exception {
460    ctor public AdServicesException(@Nullable String, @Nullable Throwable);
461    ctor public AdServicesException(@Nullable String);
462  }
463
464}
465
466package android.adservices.measurement {
467
468  public class DeletionRequest {
469    method public int getDeletionMode();
470    method @NonNull public java.util.List<android.net.Uri> getDomainUris();
471    method @NonNull public java.time.Instant getEnd();
472    method public int getMatchBehavior();
473    method @NonNull public java.util.List<android.net.Uri> getOriginUris();
474    method @NonNull public java.time.Instant getStart();
475    field public static final int DELETION_MODE_ALL = 0; // 0x0
476    field public static final int DELETION_MODE_EXCLUDE_INTERNAL_DATA = 1; // 0x1
477    field public static final int MATCH_BEHAVIOR_DELETE = 0; // 0x0
478    field public static final int MATCH_BEHAVIOR_PRESERVE = 1; // 0x1
479  }
480
481  public static final class DeletionRequest.Builder {
482    ctor public DeletionRequest.Builder();
483    method @NonNull public android.adservices.measurement.DeletionRequest build();
484    method @NonNull public android.adservices.measurement.DeletionRequest.Builder setDeletionMode(int);
485    method @NonNull public android.adservices.measurement.DeletionRequest.Builder setDomainUris(@Nullable java.util.List<android.net.Uri>);
486    method @NonNull public android.adservices.measurement.DeletionRequest.Builder setEnd(@NonNull java.time.Instant);
487    method @NonNull public android.adservices.measurement.DeletionRequest.Builder setMatchBehavior(int);
488    method @NonNull public android.adservices.measurement.DeletionRequest.Builder setOriginUris(@Nullable java.util.List<android.net.Uri>);
489    method @NonNull public android.adservices.measurement.DeletionRequest.Builder setStart(@NonNull java.time.Instant);
490  }
491
492  public class MeasurementManager {
493    method public void deleteRegistrations(@NonNull android.adservices.measurement.DeletionRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
494    method @NonNull public static android.adservices.measurement.MeasurementManager get(@NonNull android.content.Context);
495    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION) public void getMeasurementApiStatus(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Integer,java.lang.Exception>);
496    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION) public void registerSource(@NonNull android.net.Uri, @Nullable android.view.InputEvent, @Nullable java.util.concurrent.Executor, @Nullable android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
497    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION) public void registerSource(@NonNull android.adservices.measurement.SourceRegistrationRequest, @Nullable java.util.concurrent.Executor, @Nullable android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
498    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION) public void registerTrigger(@NonNull android.net.Uri, @Nullable java.util.concurrent.Executor, @Nullable android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
499    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION) public void registerWebSource(@NonNull android.adservices.measurement.WebSourceRegistrationRequest, @Nullable java.util.concurrent.Executor, @Nullable android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
500    method @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION) public void registerWebTrigger(@NonNull android.adservices.measurement.WebTriggerRegistrationRequest, @Nullable java.util.concurrent.Executor, @Nullable android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>);
501    field public static final int MEASUREMENT_API_STATE_DISABLED = 0; // 0x0
502    field public static final int MEASUREMENT_API_STATE_ENABLED = 1; // 0x1
503  }
504
505  public final class SourceRegistrationRequest implements android.os.Parcelable {
506    method public int describeContents();
507    method @Nullable public android.view.InputEvent getInputEvent();
508    method @NonNull public java.util.List<android.net.Uri> getRegistrationUris();
509    method public void writeToParcel(@NonNull android.os.Parcel, int);
510    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.measurement.SourceRegistrationRequest> CREATOR;
511  }
512
513  public static final class SourceRegistrationRequest.Builder {
514    ctor public SourceRegistrationRequest.Builder(@NonNull java.util.List<android.net.Uri>);
515    method @NonNull public android.adservices.measurement.SourceRegistrationRequest build();
516    method @NonNull public android.adservices.measurement.SourceRegistrationRequest.Builder setInputEvent(@Nullable android.view.InputEvent);
517  }
518
519  public final class WebSourceParams implements android.os.Parcelable {
520    method public int describeContents();
521    method @NonNull public android.net.Uri getRegistrationUri();
522    method public boolean isDebugKeyAllowed();
523    method public void writeToParcel(@NonNull android.os.Parcel, int);
524    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.measurement.WebSourceParams> CREATOR;
525  }
526
527  public static final class WebSourceParams.Builder {
528    ctor public WebSourceParams.Builder(@NonNull android.net.Uri);
529    method @NonNull public android.adservices.measurement.WebSourceParams build();
530    method @NonNull public android.adservices.measurement.WebSourceParams.Builder setDebugKeyAllowed(boolean);
531  }
532
533  public final class WebSourceRegistrationRequest implements android.os.Parcelable {
534    method public int describeContents();
535    method @Nullable public android.net.Uri getAppDestination();
536    method @Nullable public android.view.InputEvent getInputEvent();
537    method @NonNull public java.util.List<android.adservices.measurement.WebSourceParams> getSourceParams();
538    method @NonNull public android.net.Uri getTopOriginUri();
539    method @Nullable public android.net.Uri getVerifiedDestination();
540    method @Nullable public android.net.Uri getWebDestination();
541    method public void writeToParcel(@NonNull android.os.Parcel, int);
542    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.measurement.WebSourceRegistrationRequest> CREATOR;
543  }
544
545  public static final class WebSourceRegistrationRequest.Builder {
546    ctor public WebSourceRegistrationRequest.Builder(@NonNull java.util.List<android.adservices.measurement.WebSourceParams>, @NonNull android.net.Uri);
547    method @NonNull public android.adservices.measurement.WebSourceRegistrationRequest build();
548    method @NonNull public android.adservices.measurement.WebSourceRegistrationRequest.Builder setAppDestination(@Nullable android.net.Uri);
549    method @NonNull public android.adservices.measurement.WebSourceRegistrationRequest.Builder setInputEvent(@Nullable android.view.InputEvent);
550    method @NonNull public android.adservices.measurement.WebSourceRegistrationRequest.Builder setVerifiedDestination(@Nullable android.net.Uri);
551    method @NonNull public android.adservices.measurement.WebSourceRegistrationRequest.Builder setWebDestination(@Nullable android.net.Uri);
552  }
553
554  public final class WebTriggerParams implements android.os.Parcelable {
555    method public int describeContents();
556    method @NonNull public android.net.Uri getRegistrationUri();
557    method public boolean isDebugKeyAllowed();
558    method public void writeToParcel(@NonNull android.os.Parcel, int);
559    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.measurement.WebTriggerParams> CREATOR;
560  }
561
562  public static final class WebTriggerParams.Builder {
563    ctor public WebTriggerParams.Builder(@NonNull android.net.Uri);
564    method @NonNull public android.adservices.measurement.WebTriggerParams build();
565    method @NonNull public android.adservices.measurement.WebTriggerParams.Builder setDebugKeyAllowed(boolean);
566  }
567
568  public final class WebTriggerRegistrationRequest implements android.os.Parcelable {
569    method public int describeContents();
570    method @NonNull public android.net.Uri getDestination();
571    method @NonNull public java.util.List<android.adservices.measurement.WebTriggerParams> getTriggerParams();
572    method public void writeToParcel(@NonNull android.os.Parcel, int);
573    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.measurement.WebTriggerRegistrationRequest> CREATOR;
574  }
575
576  public static final class WebTriggerRegistrationRequest.Builder {
577    ctor public WebTriggerRegistrationRequest.Builder(@NonNull java.util.List<android.adservices.measurement.WebTriggerParams>, @NonNull android.net.Uri);
578    method @NonNull public android.adservices.measurement.WebTriggerRegistrationRequest build();
579  }
580
581}
582
583package android.adservices.topics {
584
585  public final class GetTopicsRequest {
586    method @NonNull public String getAdsSdkName();
587    method public boolean shouldRecordObservation();
588  }
589
590  public static final class GetTopicsRequest.Builder {
591    ctor public GetTopicsRequest.Builder();
592    method @NonNull public android.adservices.topics.GetTopicsRequest build();
593    method @NonNull public android.adservices.topics.GetTopicsRequest.Builder setAdsSdkName(@NonNull String);
594    method @NonNull public android.adservices.topics.GetTopicsRequest.Builder setShouldRecordObservation(boolean);
595  }
596
597  public final class GetTopicsResponse {
598    method @NonNull public java.util.List<android.adservices.topics.Topic> getTopics();
599  }
600
601  public static final class GetTopicsResponse.Builder {
602    ctor public GetTopicsResponse.Builder(@NonNull java.util.List<android.adservices.topics.Topic>);
603    method @NonNull public android.adservices.topics.GetTopicsResponse build();
604  }
605
606  public final class Topic {
607    ctor public Topic(long, long, int);
608    method public long getModelVersion();
609    method public long getTaxonomyVersion();
610    method public int getTopicId();
611  }
612
613  public final class TopicsManager {
614    method @NonNull public static android.adservices.topics.TopicsManager get(@NonNull android.content.Context);
615    method @NonNull @RequiresPermission(android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_TOPICS) public void getTopics(@NonNull android.adservices.topics.GetTopicsRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<android.adservices.topics.GetTopicsResponse,java.lang.Exception>);
616  }
617
618}
619
620