xref: /aosp_15_r20/prebuilts/sdk/35/system/api/framework-adservices.txt (revision 344a7f5ef16c479e7a7f54ee6567a9d112f9e72b)

// Signature format: 2.0
package android.adservices.adid {

  public abstract class AdIdProviderService extends android.app.Service {
    ctor public AdIdProviderService();
    method @Nullable public final android.os.IBinder onBind(@Nullable android.content.Intent);
    method @NonNull public abstract android.adservices.adid.AdId onGetAdId(int, @NonNull String) throws java.io.IOException;
    field public static final String SERVICE_INTERFACE = "android.adservices.adid.AdIdProviderService";
  }

}

package android.adservices.appsetid {

  public abstract class AppSetIdProviderService extends android.app.Service {
    ctor public AppSetIdProviderService();
    method @Nullable public final android.os.IBinder onBind(@Nullable android.content.Intent);
    method @NonNull public abstract android.adservices.appsetid.AppSetId onGetAppSetId(int, @NonNull String) throws java.io.IOException;
    field public static final String SERVICE_INTERFACE = "android.adservices.appsetid.AppSetIdProviderService";
  }

}

package android.adservices.cobalt {

  public abstract class AdServicesCobaltUploadService extends android.app.Service {
    ctor public AdServicesCobaltUploadService();
    method @Nullable public final android.os.IBinder onBind(@Nullable android.content.Intent);
    method public abstract void onUploadEncryptedCobaltEnvelope(@NonNull android.adservices.cobalt.EncryptedCobaltEnvelopeParams);
    field public static final String SERVICE_INTERFACE = "android.adservices.cobalt.AdServicesCobaltUploadService";
  }

  public final class EncryptedCobaltEnvelopeParams implements android.os.Parcelable {
    ctor public EncryptedCobaltEnvelopeParams(int, @NonNull int, @NonNull byte[]);
    method public int describeContents();
    method @NonNull public byte[] getCipherText();
    method @NonNull public int getEnvironment();
    method @NonNull public int getKeyIndex();
    method public void writeToParcel(@NonNull android.os.Parcel, int);
    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.cobalt.EncryptedCobaltEnvelopeParams> CREATOR;
    field public static final int ENVIRONMENT_DEV = 1; // 0x1
    field public static final int ENVIRONMENT_PROD = 0; // 0x0
  }

}

package android.adservices.common {

  public class AdServicesCommonManager {
    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>);
    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>);
    method @NonNull public static android.adservices.common.AdServicesCommonManager get(@NonNull android.content.Context);
    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>);
    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>);
    method @RequiresPermission(anyOf={android.adservices.common.AdServicesPermissions.MODIFY_ADSERVICES_STATE, android.adservices.common.AdServicesPermissions.MODIFY_ADSERVICES_STATE_COMPAT}) public void setAdServicesEnabled(boolean, boolean);
    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>);
    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>);
  }

  public class AdServicesPermissions {
    field public static final String ACCESS_ADSERVICES_STATE = "android.permission.ACCESS_ADSERVICES_STATE";
    field public static final String ACCESS_ADSERVICES_STATE_COMPAT = "android.permission.ACCESS_ADSERVICES_STATE_COMPAT";
    field public static final String ACCESS_PRIVILEGED_ADSERVICES_COBALT_UPLOAD = "android.permission.ACCESS_PRIVILEGED_AD_SERVICES_COBALT_UPLOAD";
    field public static final String ACCESS_PRIVILEGED_AD_ID = "android.permission.ACCESS_PRIVILEGED_AD_ID";
    field public static final String ACCESS_PRIVILEGED_APP_SET_ID = "android.permission.ACCESS_PRIVILEGED_APP_SET_ID";
    field public static final String MODIFY_ADSERVICES_STATE = "android.permission.MODIFY_ADSERVICES_STATE";
    field public static final String MODIFY_ADSERVICES_STATE_COMPAT = "android.permission.MODIFY_ADSERVICES_STATE_COMPAT";
    field public static final String UPDATE_PRIVILEGED_AD_ID = "android.permission.UPDATE_PRIVILEGED_AD_ID";
    field public static final String UPDATE_PRIVILEGED_AD_ID_COMPAT = "android.permission.UPDATE_PRIVILEGED_AD_ID_COMPAT";
  }

  public final class AdServicesStates implements android.os.Parcelable {
    method public int describeContents();
    method @NonNull public boolean isAdIdEnabled();
    method @NonNull public boolean isAdultAccount();
    method @NonNull public boolean isPrivacySandboxUiEnabled();
    method @NonNull public boolean isPrivacySandboxUiRequest();
    method @NonNull public boolean isU18Account();
    method public void writeToParcel(@NonNull android.os.Parcel, int);
    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.common.AdServicesStates> CREATOR;
  }

  public static final class AdServicesStates.Builder {
    ctor public AdServicesStates.Builder();
    method @NonNull public android.adservices.common.AdServicesStates build();
    method @NonNull public android.adservices.common.AdServicesStates.Builder setAdIdEnabled(boolean);
    method @NonNull public android.adservices.common.AdServicesStates.Builder setAdultAccount(boolean);
    method @NonNull public android.adservices.common.AdServicesStates.Builder setPrivacySandboxUiEnabled(boolean);
    method @NonNull public android.adservices.common.AdServicesStates.Builder setPrivacySandboxUiRequest(boolean);
    method @NonNull public android.adservices.common.AdServicesStates.Builder setU18Account(boolean);
  }

  public final class EnableAdServicesResponse implements android.os.Parcelable {
    method public int describeContents();
    method public boolean isApiEnabled();
    method public boolean isSuccess();
    method public void writeToParcel(@NonNull android.os.Parcel, int);
    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.common.EnableAdServicesResponse> CREATOR;
  }

  public final class UpdateAdIdRequest implements android.os.Parcelable {
    method public int describeContents();
    method @NonNull public String getAdId();
    method public boolean isLimitAdTrackingEnabled();
    method public void writeToParcel(@NonNull android.os.Parcel, int);
    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.common.UpdateAdIdRequest> CREATOR;
  }

  public static final class UpdateAdIdRequest.Builder {
    ctor public UpdateAdIdRequest.Builder(@NonNull String);
    method @NonNull public android.adservices.common.UpdateAdIdRequest build();
    method @NonNull public android.adservices.common.UpdateAdIdRequest.Builder setLimitAdTrackingEnabled(boolean);
  }

}

package android.adservices.extdata {

  public final class AdServicesExtDataParams implements android.os.Parcelable {
    ctor public AdServicesExtDataParams(int, int, int, int, int, long);
    method public int describeContents();
    method public int getIsAdultAccount();
    method public int getIsMeasurementConsented();
    method public int getIsNotificationDisplayed();
    method public int getIsU18Account();
    method public int getManualInteractionWithConsentStatus();
    method public long getMeasurementRollbackApexVersion();
    method public void writeToParcel(@NonNull android.os.Parcel, int);
    field @NonNull public static final android.os.Parcelable.Creator<android.adservices.extdata.AdServicesExtDataParams> CREATOR;
  }

  public abstract class AdServicesExtDataStorageService extends android.app.Service {
    ctor public AdServicesExtDataStorageService();
    method @Nullable public final android.os.IBinder onBind(@Nullable android.content.Intent);
    method @NonNull public abstract android.adservices.extdata.AdServicesExtDataParams onGetAdServicesExtData();
    method public abstract void onPutAdServicesExtData(@NonNull android.adservices.extdata.AdServicesExtDataParams, @NonNull int[]);
    field public static final int FIELD_IS_ADULT_ACCOUNT = 3; // 0x3
    field public static final int FIELD_IS_MEASUREMENT_CONSENTED = 1; // 0x1
    field public static final int FIELD_IS_NOTIFICATION_DISPLAYED = 0; // 0x0
    field public static final int FIELD_IS_U18_ACCOUNT = 2; // 0x2
    field public static final int FIELD_MANUAL_INTERACTION_WITH_CONSENT_STATUS = 4; // 0x4
    field public static final int FIELD_MEASUREMENT_ROLLBACK_APEX_VERSION = 5; // 0x5
    field public static final String SERVICE_INTERFACE = "android.adservices.extdata.AdServicesExtDataStorageService";
  }

}