请求年龄信号

本文档介绍了如何使用 Play Age Signals API 请求年龄信号。

Play Age Signals 0.0.4 SDK 引入了双函数架构,旨在简化年龄信号请求,并支持基于用户选择的模型。如需请求年龄信号,请使用以下简要工作流程:

调用 requestAgeSignalsAccess(Activity) 方法,该方法会返回 ageSignalsStatus。ageSignalsStatus 的值可以是 SHARED、NOT_SHARED 或 VERIFICATION_REQUIRED。

  • 如果为 ageSignalsStatus == NOT_SHARED:您的应用不会在 API 响应中收到年龄信号。
  • 如果为 ageSignalsStatus == SHARED:调用 checkAgeSignals() 方法。如果用户或家长决定分享年龄信号,您会在 API 响应中收到年龄信号,并可以决定如何处理该响应。
  • 如果为 ageSignalsStatus == VERIFICATION_REQUIRED:用户的年龄未知,且用户位于必须进行年龄验证和年龄信号共享的适用管辖区或地区。如需在这些地区从 Google Play 获取年龄信号,请让用户访问 Play 商店以解决其状态问题。

requestAgeSignalsAccess(Activity) 方法会根据某个地区是否适用强制年龄分享而返回不同的值:

  • 对于美国某些州符合条件的用户,如果当地法律要求应用商店向开发者提供经过验证的年龄信息,则不会触发应用内提示。而是会在用户访问 Play 商店应用时要求其验证或设置监督功能。请使用 ageSignalsStatus 的值来确定验证状态:
  • 对于其他地区的用户,如果年龄信息共享取决于用户或家长的选择:
    • 如果用户的设置为分享前询问,系统会显示应用内提示。如果用户同意分享其年龄,则 ageSignalsStatus 的值为 SHARED;否则为 NOT_SHARED。
    • 如果用户的设置为始终分享,则系统不会显示应用内提示,并且 ageSignalsStatus 的值为 SHARED。
    • 如果用户的设置为从不分享,则系统不会显示应用内提示,并且 ageSignalsStatus 的值为 NOT_SHARED。
    • 对于受监督用户,家长可以在 Family Link 应用设置中选择分享孩子的年龄。如果家长选择分享年龄,ageSignalsStatus 的值将为 SHARED,否则将为 NOT_SHARED。

如需了解 Google Play 上的年龄分享功能(包括应用内提示和年龄共享设置)的运作方式,请参阅 Google Play 上的年龄段分享功能。

以下示例展示了如何请求年龄信号:

Kotlin

// 1. Initialize the AgeSignalsManager (usually in onCreate or class initialization)
val ageSignalsManager = AgeSignalsManagerFactory.create(applicationContext)

// 2. Request or check for age signals access.
// Passing the current Activity allows the Play Store to render the age sharing prompt UI if required.
val accessRequest = AgeSignalsAccessRequest.builder()
    .setActivity(this)
    .build()

ageSignalsManager.requestAgeSignalsAccess(accessRequest)
    .addOnSuccessListener { accessResult ->
        if (accessResult.ageSignalsStatus() == AgeSignalsStatus.SHARED) {
            // The user (or parent) has agreed to share age range, or is in an eligible auto-share region.
            // Retrieve the actual age signals.
            retrieveAgeSignals(ageSignalsManager)
        } else {
            // Age signals are not shared (user didn't share age range, parent rejected the request, or not eligible).
        }
    }
    .addOnFailureListener { exception ->
        // Handle API/Play Store connection and system errors
        handleAgeSignalsError(exception)
    }

private fun retrieveAgeSignals(manager: AgeSignalsManager) {
    // 3. Perform the actual age signals query once sharing is active.
    manager.checkAgeSignals(AgeSignalsRequest.builder().build())
        .addOnSuccessListener { ageSignalsResult ->
            val installId = ageSignalsResult.installId()
            val ageLower = ageSignalsResult.ageLower()
            val ageUpper = ageSignalsResult.ageUpper()
            val significantChangeDate = ageSignalsResult.significantChangeApprovalDate()
            val ageRangeSource = ageSignalsResult.ageRangeSource()

            if (ageLower != null) {
                if (ageUpper != null) {
                    // The user is in a specific closed age range [ageLower, ageUpper] (e.g. [13, 15])
                } else {
                    // The user is in the highest open-ended age band [ageLower, null] (e.g. [18, null])
                }
            } else {
                // Both bounds are null: The user is not sharing their age
            }
        }
        .addOnFailureListener { exception ->
            handleAgeSignalsError(exception)
        }
}

Java

// 1. Initialize the AgeSignalsManager (usually in onCreate or class initialization)
AgeSignalsManager ageSignalsManager = AgeSignalsManagerFactory.create(getApplicationContext());

// 2. Request or check for age signals access.
// Passing the current Activity allows the Play Store to render the age sharing prompt UI if required.
AgeSignalsAccessRequest accessRequest = AgeSignalsAccessRequest.builder()
    .setActivity(this)
    .build();

ageSignalsManager.requestAgeSignalsAccess(accessRequest)
    .addOnSuccessListener(accessResult -> {
        Integer status = accessResult.ageSignalsStatus();
        if (status == AgeSignalsStatus.SHARED) {
            // The user (or parent) has agreed to share age range, or is in an eligible auto-share region.
            // Retrieve the actual age signals.
            retrieveAgeSignals(ageSignalsManager);
        } else {
            // Age signals are not shared (user didn't share age range, parent rejected the request, or not eligible).
        }
    })
    .addOnFailureListener(exception -> {
        // Handle API/Play Store connection and system errors
    });

private void retrieveAgeSignals(AgeSignalsManager manager) {
    // 3. Perform the actual age signals query once sharing is active.
    manager.checkAgeSignals(AgeSignalsRequest.builder().build())
        .addOnSuccessListener(ageSignalsResult -> {
            String installId = ageSignalsResult.installId();
            Integer ageLower = ageSignalsResult.ageLower();
            Integer ageUpper = ageSignalsResult.ageUpper();
            Date significantChangeDate = ageSignalsResult.significantChangeApprovalDate();
            @AgeRangeSource Integer ageRangeSource = ageSignalsResult.ageRangeSource();

            if (ageLower != null) {
                if (ageUpper != null) {
                    // The user is in a specific closed age range [ageLower, ageUpper] (e.g. [13, 15])
                } else {
                    // The user is in the highest open-ended age band [ageLower, null] (e.g. [18, null])
                }
            } else {
                // Both bounds are null: The user is not sharing their age (e.g. they are a verified adult)
            }
        })
        .addOnFailureListener(exception -> {
            handleAgeSignalsError(exception);
        });
}

代码要点

  • requestAgeSignalsAccess(Activity) 方法会对用户当前的年龄信号和年龄信号共享状态执行阻塞检查。
  • 在您调用 requestAgeSignalsAccess(Activity) 后,Play 仅会向不受监督的用户显示内置的应用内提示。受监督用户的家长可以通过在 Family Link 应用中管理年龄分享设置,选择是否分享孩子的年龄。
  • 如果用户关闭或拒绝分享年龄,系统会显示几次应用内提示,然后不再显示。
  • checkAgeSignals() 方法会获取 API 响应中的年龄信号值。此方法会返回 ageRangeSource、ageUpper、ageLower 和其他显著变化值。