MeasurementManagerImplCommon.kt
/*
* Copyright 2023 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 androidx.privacysandbox.ads.adservices.measurement
import android.adservices.common.AdServicesPermissions
import android.annotation.SuppressLint
import android.net.Uri
import android.os.Build
import android.os.ext.SdkExtensions
import android.view.InputEvent
import androidx.annotation.DoNotInline
import androidx.annotation.RequiresExtension
import androidx.annotation.RequiresPermission
import androidx.annotation.RestrictTo
import androidx.core.os.asOutcomeReceiver
import androidx.privacysandbox.ads.adservices.common.ExperimentalFeatures
import kotlinx.coroutines.coroutineScope
import kotlinx.coroutines.launch
import kotlinx.coroutines.suspendCancellableCoroutine
@RestrictTo(RestrictTo.Scope.LIBRARY)
@SuppressLint("NewApi", "ClassVerificationFailure")
@RequiresExtension(extension = SdkExtensions.AD_SERVICES, version = 5)
@RequiresExtension(extension = Build.VERSION_CODES.S, version = 9)
open class MeasurementManagerImplCommon(
protected val mMeasurementManager: android.adservices.measurement.MeasurementManager
) : MeasurementManager() {
@DoNotInline
override suspend fun deleteRegistrations(deletionRequest: DeletionRequest) {
suspendCancellableCoroutine<Any> { continuation ->
mMeasurementManager.deleteRegistrations(
convertDeletionRequest(deletionRequest),
Runnable::run,
continuation.asOutcomeReceiver()
)
}
}
private fun convertDeletionRequest(
request: DeletionRequest
): android.adservices.measurement.DeletionRequest {
return android.adservices.measurement.DeletionRequest.Builder()
.setDeletionMode(request.deletionMode)
.setMatchBehavior(request.matchBehavior)
.setStart(request.start)
.setEnd(request.end)
.setDomainUris(request.domainUris)
.setOriginUris(request.originUris)
.build()
}
@DoNotInline
@RequiresPermission(AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION)
override suspend fun registerSource(attributionSource: Uri, inputEvent: InputEvent?) {
suspendCancellableCoroutine<Any> { continuation ->
mMeasurementManager.registerSource(
attributionSource,
inputEvent,
Runnable::run,
continuation.asOutcomeReceiver()
)
}
}
@DoNotInline
@RequiresPermission(AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION)
override suspend fun registerTrigger(trigger: Uri) {
suspendCancellableCoroutine<Any> { continuation ->
mMeasurementManager.registerTrigger(
trigger,
Runnable::run,
continuation.asOutcomeReceiver())
}
}
@DoNotInline
@RequiresPermission(AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION)
override suspend fun registerWebSource(request: WebSourceRegistrationRequest) {
suspendCancellableCoroutine<Any> { continuation ->
mMeasurementManager.registerWebSource(
convertWebSourceRequest(request),
Runnable::run,
continuation.asOutcomeReceiver())
}
}
@DoNotInline
@ExperimentalFeatures.RegisterSourceOptIn
@RequiresPermission(AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION)
override suspend fun registerSource(
request: SourceRegistrationRequest
): Unit = coroutineScope {
request.registrationUris.forEach { uri ->
launch {
suspendCancellableCoroutine<Any> { continuation ->
mMeasurementManager.registerSource(
uri,
request.inputEvent,
Runnable::run,
continuation.asOutcomeReceiver()
)
}
}
}
}
private fun convertWebSourceRequest(
request: WebSourceRegistrationRequest
): android.adservices.measurement.WebSourceRegistrationRequest {
return android.adservices.measurement.WebSourceRegistrationRequest
.Builder(
convertWebSourceParams(request.webSourceParams),
request.topOriginUri)
.setWebDestination(request.webDestination)
.setAppDestination(request.appDestination)
.setInputEvent(request.inputEvent)
.setVerifiedDestination(request.verifiedDestination)
.build()
}
private fun convertWebSourceParams(
request: List<WebSourceParams>
): List<android.adservices.measurement.WebSourceParams> {
var result = mutableListOf<android.adservices.measurement.WebSourceParams>()
for (param in request) {
result.add(android.adservices.measurement.WebSourceParams
.Builder(param.registrationUri)
.setDebugKeyAllowed(param.debugKeyAllowed)
.build())
}
return result
}
@DoNotInline
@RequiresPermission(AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION)
override suspend fun registerWebTrigger(request: WebTriggerRegistrationRequest) {
suspendCancellableCoroutine<Any> { continuation ->
mMeasurementManager.registerWebTrigger(
convertWebTriggerRequest(request),
Runnable::run,
continuation.asOutcomeReceiver())
}
}
private fun convertWebTriggerRequest(
request: WebTriggerRegistrationRequest
): android.adservices.measurement.WebTriggerRegistrationRequest {
return android.adservices.measurement.WebTriggerRegistrationRequest
.Builder(
convertWebTriggerParams(request.webTriggerParams),
request.destination)
.build()
}
private fun convertWebTriggerParams(
request: List<WebTriggerParams>
): List<android.adservices.measurement.WebTriggerParams> {
var result = mutableListOf<android.adservices.measurement.WebTriggerParams>()
for (param in request) {
result.add(android.adservices.measurement.WebTriggerParams
.Builder(param.registrationUri)
.setDebugKeyAllowed(param.debugKeyAllowed)
.build())
}
return result
}
@DoNotInline
@RequiresPermission(AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION)
override suspend fun getMeasurementApiStatus(): Int = suspendCancellableCoroutine {
continuation ->
mMeasurementManager.getMeasurementApiStatus(
Runnable::run,
continuation.asOutcomeReceiver())
}
}