Use Play Age Signals API (beta)

By using the Play Age Signals API (beta), you agree to the terms of service and you agree to comply with all Google Play developer policies. To request the user's status and age range, you call the API from your app at runtime. The Play Age Signals API only returns data for users based in regions where Play is required by law to provide age category data.

Play returns an age range based on the age bands defined by the applicable jurisdiction and regions. The default ages the API returns in applicable jurisdictions and regions are 0-12, 13-15, 16-17, and 18+ but these may change based on regional requirements.

Integrate Play Age Signals API into your app

To integrate the Play Age Signals API into your app, add the following dependency to your app's build.gradle file:

implementation 'com.google.android.play:age-signals:0.0.1-beta01'

Request age signals

Here's an example of making an age signals request:

// Create an instance of a manager
AgeSignalsManager ageSignalsManager =
    AgeSignalsManagerFactory.create(ApplicationProvider.getApplicationContext());

// Request an age signals check
ageSignalsManager
    .checkAgeSignals(AgeSignalsRequest.builder().build())
    .addOnSuccessListener(
        ageSignalsResult -> {
          // Store the install ID for later...
          String installId = ageSignalsResult.installId();

          if (ageSignalsResult
              .userStatus()
              .equals(AgeSignalsVerificationStatus.SUPERVISED_APPROVAL_DENIED)) {
            // Disallow access ...
          } else {
            // Do something else if the user is SUPERVISED, VERIFIED, etc.
          }
        });

Age signals are stored by Google Play on the device for each user. When a user with a supervised Google Account ages into a new age range, Google Play automatically updates the cached age signals for that user within 2 to 8 weeks following the user's birthday.

(Optional) Receive custom age ranges

The default age ranges that the API returns in applicable jurisdictions and regions are 0-12, 13-15, 16-17, and 18+. These may change in the future based on local requirements.

Alternatively, to customize the age ranges according to your app's minimum ages, you can provide these minimum ages for your app on the Age signals page in your Google Play Console. The Age Signals API returns the customized age ranges. For example, if you provide minimum ages of 9, 15, and 17, a 14-year-old user would fall within the 10-15 age range. Minimum ages must be at least 2 years apart and can be changed once annually.

To customize the age ranges returned by the Age Signals API, you can provide minimum ages for your app:

1. Go to the Age signals page in your Play Console.
2. On the App's minimum ages tab, enter up to three minimum ages for your app.
3. Click Save.

Age signals responses

The Play Age Signals API (beta) response includes the following fields and values. The values are subject to change. If you want the most recent values, request an API response when your app opens. You are responsible for providing age-appropriate experiences using these signals.

Handle API error codes

If your app makes a Play Age Signals API (beta) request and the call fails, your app receives an error code. These errors can happen for various reasons, such as the Play Store app being out of date.

Retry strategy

In situations where the user is in session, we recommend implementing a retry strategy with a maximum number of attempts as an exit condition so that the error disrupts the user experience as little as possible.