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
|
/*
* 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 android.adservices.appsetid;
import android.adservices.common.AdServicesStatusUtils;
import android.adservices.common.CallerMetadata;
import android.adservices.common.SandboxedSdkContextUtils;
import android.annotation.CallbackExecutor;
import android.annotation.NonNull;
import android.app.sdksandbox.SandboxedSdkContext;
import android.content.Context;
import android.os.Build;
import android.os.OutcomeReceiver;
import android.os.RemoteException;
import android.os.SystemClock;
import androidx.annotation.RequiresApi;
import com.android.adservices.AdServicesCommon;
import com.android.adservices.LogUtil;
import com.android.adservices.ServiceBinder;
import java.util.Objects;
import java.util.concurrent.Executor;
/**
* AppSetIdManager provides APIs for app and ad-SDKs to access appSetId for non-monetizing purpose.
*/
// TODO(b/269798827): Enable for R.
@RequiresApi(Build.VERSION_CODES.S)
public class AppSetIdManager {
/**
* Service used for registering AppSetIdManager in the system service registry.
*
* @hide
*/
public static final String APPSETID_SERVICE = "appsetid_service";
/* When an app calls the AppSetId API directly, it sets the SDK name to empty string. */
static final String EMPTY_SDK = "";
private Context mContext;
private ServiceBinder<IAppSetIdService> mServiceBinder;
/**
* Factory method for creating an instance of AppSetIdManager.
*
* @param context The {@link Context} to use
* @return A {@link AppSetIdManager} instance
*/
@NonNull
public static AppSetIdManager get(@NonNull Context context) {
// On T+, context.getSystemService() does more than just call constructor.
return (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU)
? context.getSystemService(AppSetIdManager.class)
: new AppSetIdManager(context);
}
/**
* Create AppSetIdManager
*
* @hide
*/
public AppSetIdManager(Context context) {
// In case the AppSetIdManager is initiated from inside a sdk_sandbox process the fields
// will be immediately rewritten by the initialize method below.
initialize(context);
}
/**
* Initializes {@link AppSetIdManager} with the given {@code context}.
*
* <p>This method is called by the {@link SandboxedSdkContext} to propagate the correct context.
* For more information check the javadoc on the {@link
* android.app.sdksandbox.SdkSandboxSystemServiceRegistry}.
*
* @hide
* @see android.app.sdksandbox.SdkSandboxSystemServiceRegistry
*/
public AppSetIdManager initialize(Context context) {
mContext = context;
mServiceBinder =
ServiceBinder.getServiceBinder(
context,
AdServicesCommon.ACTION_APPSETID_SERVICE,
IAppSetIdService.Stub::asInterface);
return this;
}
@NonNull
private IAppSetIdService getService(
@CallbackExecutor Executor executor, OutcomeReceiver<AppSetId, Exception> callback) {
IAppSetIdService service = null;
try {
service = mServiceBinder.getService();
} catch (RuntimeException e) {
LogUtil.e(e, "Failed binding to AppSetId service");
executor.execute(() -> callback.onError(e));
}
return service;
}
@NonNull
private Context getContext() {
return mContext;
}
/**
* Retrieve the AppSetId.
*
* @param executor The executor to run callback.
* @param callback The callback that's called after appsetid are available or an error occurs.
*/
@NonNull
public void getAppSetId(
@NonNull @CallbackExecutor Executor executor,
@NonNull OutcomeReceiver<AppSetId, Exception> callback) {
Objects.requireNonNull(executor);
Objects.requireNonNull(callback);
CallerMetadata callerMetadata =
new CallerMetadata.Builder()
.setBinderElapsedTimestamp(SystemClock.elapsedRealtime())
.build();
String appPackageName = "";
String sdkPackageName = "";
// First check if context is SandboxedSdkContext or not
Context getAppSetIdRequestContext = getContext();
SandboxedSdkContext requestContext =
SandboxedSdkContextUtils.getAsSandboxedSdkContext(getAppSetIdRequestContext);
if (requestContext != null) {
sdkPackageName = requestContext.getSdkPackageName();
appPackageName = requestContext.getClientPackageName();
} else { // This is the case without the Sandbox.
appPackageName = getAppSetIdRequestContext.getPackageName();
}
try {
IAppSetIdService service = getService(executor, callback);
if (service == null) {
LogUtil.d("Unable to find AppSetId service");
return;
}
service.getAppSetId(
new GetAppSetIdParam.Builder()
.setAppPackageName(appPackageName)
.setSdkPackageName(sdkPackageName)
.build(),
callerMetadata,
new IGetAppSetIdCallback.Stub() {
@Override
public void onResult(GetAppSetIdResult resultParcel) {
executor.execute(
() -> {
if (resultParcel.isSuccess()) {
callback.onResult(
new AppSetId(
resultParcel.getAppSetId(),
resultParcel.getAppSetIdScope()));
} else {
callback.onError(
AdServicesStatusUtils.asException(
resultParcel));
}
});
}
@Override
public void onError(int resultCode) {
executor.execute(
() ->
callback.onError(
AdServicesStatusUtils.asException(resultCode)));
}
});
} catch (RemoteException e) {
LogUtil.e("RemoteException", e);
callback.onError(e);
}
}
/**
* If the service is in an APK (as opposed to the system service), unbind it from the service to
* allow the APK process to die.
*
* @hide
*/
// TODO: change to @VisibleForTesting
public void unbindFromService() {
mServiceBinder.unbindFromService();
}
}
|
