xref: /aosp_15_r20/prebuilts/sdk/35/system/api/framework-adservices.txt (revision 344a7f5ef16c479e7a7f54ee6567a9d112f9e72b) 
1// Signature format: 2.0
2package android.adservices.adid {
3
4  public abstract class AdIdProviderService extends android.app.Service {
5    ctor public AdIdProviderService();
6    method @Nullable public final android.os.IBinder onBind(@Nullable android.content.Intent);
7    method @NonNull public abstract android.adservices.adid.AdId onGetAdId(int, @NonNull String) throws java.io.IOException;
8    field public static final String SERVICE_INTERFACE = "android.adservices.adid.AdIdProviderService";
9  }
10
11}
12
13package android.adservices.appsetid {
14
15  public abstract class AppSetIdProviderService extends android.app.Service {
16    ctor public AppSetIdProviderService();
17    method @Nullable public final android.os.IBinder onBind(@Nullable android.content.Intent);
18    method @NonNull public abstract android.adservices.appsetid.AppSetId onGetAppSetId(int, @NonNull String) throws java.io.IOException;
19    field public static final String SERVICE_INTERFACE = "android.adservices.appsetid.AppSetIdProviderService";
20  }
21
22}
23
24package android.adservices.cobalt {
25
26  public abstract class AdServicesCobaltUploadService extends android.app.Service {
27    ctor public AdServicesCobaltUploadService();
28    method @Nullable public final android.os.IBinder onBind(@Nullable android.content.Intent);
29    method public abstract void onUploadEncryptedCobaltEnvelope(@NonNull android.adservices.cobalt.EncryptedCobaltEnvelopeParams);
30    field public static final String SERVICE_INTERFACE = "android.adservices.cobalt.AdServicesCobaltUploadService";
31  }
32
33  public final class EncryptedCobaltEnvelopeParams implements android.os.Parcelable {
34    ctor public EncryptedCobaltEnvelopeParams(int, @NonNull int, @NonNull byte[]);
35    method public int describeContents();
36    method @NonNull public byte[] getCipherText();
37    method @NonNull public int getEnvironment();
38    method @NonNull public int getKeyIndex();
39    method public void writeToParcel(@NonNull android.os.Parcel, int);
40    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.cobalt.EncryptedCobaltEnvelopeParams> CREATOR;
41    field public static final int ENVIRONMENT_DEV = 1; // 0x1
42    field public static final int ENVIRONMENT_PROD = 0; // 0x0
43  }
44
45}
46
47package android.adservices.common {
48
49  public class AdServicesCommonManager {
50    method @RequiresPermission(anyOf={android.adservices.common.AdServicesPermissions.MODIFY_ADSERVICES_STATE, android.adservices.common.AdServicesPermissions.MODIFY_ADSERVICES_STATE_COMPAT}) public void enableAdServices(@NonNull android.adservices.common.AdServicesStates, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Boolean,java.lang.Exception>);
51    method @RequiresPermission(anyOf={android.adservices.common.AdServicesPermissions.MODIFY_ADSERVICES_STATE, android.adservices.common.AdServicesPermissions.MODIFY_ADSERVICES_STATE_COMPAT}) public void enableAdServices(@NonNull android.adservices.common.AdServicesStates, @NonNull java.util.concurrent.Executor, @NonNull android.adservices.common.AdServicesOutcomeReceiver<java.lang.Boolean,java.lang.Exception>);
52    method @NonNull public static android.adservices.common.AdServicesCommonManager get(@NonNull android.content.Context);
53    method @RequiresPermission(anyOf={android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_STATE, android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_STATE_COMPAT}) public void isAdServicesEnabled(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Boolean,java.lang.Exception>);
54    method @RequiresPermission(anyOf={android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_STATE, android.adservices.common.AdServicesPermissions.ACCESS_ADSERVICES_STATE_COMPAT}) public void isAdServicesEnabled(@NonNull java.util.concurrent.Executor, @NonNull android.adservices.common.AdServicesOutcomeReceiver<java.lang.Boolean,java.lang.Exception>);
55    method @RequiresPermission(anyOf={android.adservices.common.AdServicesPermissions.MODIFY_ADSERVICES_STATE, android.adservices.common.AdServicesPermissions.MODIFY_ADSERVICES_STATE_COMPAT}) public void setAdServicesEnabled(boolean, boolean);
56    method @RequiresPermission(anyOf={android.adservices.common.AdServicesPermissions.UPDATE_PRIVILEGED_AD_ID, android.adservices.common.AdServicesPermissions.UPDATE_PRIVILEGED_AD_ID_COMPAT}) public void updateAdId(@NonNull android.adservices.common.UpdateAdIdRequest, @NonNull java.util.concurrent.Executor, @NonNull android.adservices.common.AdServicesOutcomeReceiver<java.lang.Boolean,java.lang.Exception>);
57    method @RequiresPermission(anyOf={android.adservices.common.AdServicesPermissions.UPDATE_PRIVILEGED_AD_ID, android.adservices.common.AdServicesPermissions.UPDATE_PRIVILEGED_AD_ID_COMPAT}) public void updateAdId(@NonNull android.adservices.common.UpdateAdIdRequest, @NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.lang.Boolean,java.lang.Exception>);
58  }
59
60  public class AdServicesPermissions {
61    field public static final String ACCESS_ADSERVICES_STATE = "android.permission.ACCESS_ADSERVICES_STATE";
62    field public static final String ACCESS_ADSERVICES_STATE_COMPAT = "android.permission.ACCESS_ADSERVICES_STATE_COMPAT";
63    field public static final String ACCESS_PRIVILEGED_ADSERVICES_COBALT_UPLOAD = "android.permission.ACCESS_PRIVILEGED_AD_SERVICES_COBALT_UPLOAD";
64    field public static final String ACCESS_PRIVILEGED_AD_ID = "android.permission.ACCESS_PRIVILEGED_AD_ID";
65    field public static final String ACCESS_PRIVILEGED_APP_SET_ID = "android.permission.ACCESS_PRIVILEGED_APP_SET_ID";
66    field public static final String MODIFY_ADSERVICES_STATE = "android.permission.MODIFY_ADSERVICES_STATE";
67    field public static final String MODIFY_ADSERVICES_STATE_COMPAT = "android.permission.MODIFY_ADSERVICES_STATE_COMPAT";
68    field public static final String UPDATE_PRIVILEGED_AD_ID = "android.permission.UPDATE_PRIVILEGED_AD_ID";
69    field public static final String UPDATE_PRIVILEGED_AD_ID_COMPAT = "android.permission.UPDATE_PRIVILEGED_AD_ID_COMPAT";
70  }
71
72  public final class AdServicesStates implements android.os.Parcelable {
73    method public int describeContents();
74    method @NonNull public boolean isAdIdEnabled();
75    method @NonNull public boolean isAdultAccount();
76    method @NonNull public boolean isPrivacySandboxUiEnabled();
77    method @NonNull public boolean isPrivacySandboxUiRequest();
78    method @NonNull public boolean isU18Account();
79    method public void writeToParcel(@NonNull android.os.Parcel, int);
80    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.common.AdServicesStates> CREATOR;
81  }
82
83  public static final class AdServicesStates.Builder {
84    ctor public AdServicesStates.Builder();
85    method @NonNull public android.adservices.common.AdServicesStates build();
86    method @NonNull public android.adservices.common.AdServicesStates.Builder setAdIdEnabled(boolean);
87    method @NonNull public android.adservices.common.AdServicesStates.Builder setAdultAccount(boolean);
88    method @NonNull public android.adservices.common.AdServicesStates.Builder setPrivacySandboxUiEnabled(boolean);
89    method @NonNull public android.adservices.common.AdServicesStates.Builder setPrivacySandboxUiRequest(boolean);
90    method @NonNull public android.adservices.common.AdServicesStates.Builder setU18Account(boolean);
91  }
92
93  public final class EnableAdServicesResponse implements android.os.Parcelable {
94    method public int describeContents();
95    method public boolean isApiEnabled();
96    method public boolean isSuccess();
97    method public void writeToParcel(@NonNull android.os.Parcel, int);
98    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.common.EnableAdServicesResponse> CREATOR;
99  }
100
101  public final class UpdateAdIdRequest implements android.os.Parcelable {
102    method public int describeContents();
103    method @NonNull public String getAdId();
104    method public boolean isLimitAdTrackingEnabled();
105    method public void writeToParcel(@NonNull android.os.Parcel, int);
106    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.common.UpdateAdIdRequest> CREATOR;
107  }
108
109  public static final class UpdateAdIdRequest.Builder {
110    ctor public UpdateAdIdRequest.Builder(@NonNull String);
111    method @NonNull public android.adservices.common.UpdateAdIdRequest build();
112    method @NonNull public android.adservices.common.UpdateAdIdRequest.Builder setLimitAdTrackingEnabled(boolean);
113  }
114
115}
116
117package android.adservices.extdata {
118
119  public final class AdServicesExtDataParams implements android.os.Parcelable {
120    ctor public AdServicesExtDataParams(int, int, int, int, int, long);
121    method public int describeContents();
122    method public int getIsAdultAccount();
123    method public int getIsMeasurementConsented();
124    method public int getIsNotificationDisplayed();
125    method public int getIsU18Account();
126    method public int getManualInteractionWithConsentStatus();
127    method public long getMeasurementRollbackApexVersion();
128    method public void writeToParcel(@NonNull android.os.Parcel, int);
129    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.extdata.AdServicesExtDataParams> CREATOR;
130  }
131
132  public abstract class AdServicesExtDataStorageService extends android.app.Service {
133    ctor public AdServicesExtDataStorageService();
134    method @Nullable public final android.os.IBinder onBind(@Nullable android.content.Intent);
135    method @NonNull public abstract android.adservices.extdata.AdServicesExtDataParams onGetAdServicesExtData();
136    method public abstract void onPutAdServicesExtData(@NonNull android.adservices.extdata.AdServicesExtDataParams, @NonNull int[]);
137    field public static final int FIELD_IS_ADULT_ACCOUNT = 3; // 0x3
138    field public static final int FIELD_IS_MEASUREMENT_CONSENTED = 1; // 0x1
139    field public static final int FIELD_IS_NOTIFICATION_DISPLAYED = 0; // 0x0
140    field public static final int FIELD_IS_U18_ACCOUNT = 2; // 0x2
141    field public static final int FIELD_MANUAL_INTERACTION_WITH_CONSENT_STATUS = 4; // 0x4
142    field public static final int FIELD_MEASUREMENT_ROLLBACK_APEX_VERSION = 5; // 0x5
143    field public static final String SERVICE_INTERFACE = "android.adservices.extdata.AdServicesExtDataStorageService";
144  }
145
146}
147
148