NonSdkApi

A non-sdk API and examples of it being called along with other metadata Seehttps://developer.android.com/distribute/best-practices/develop/restrictions-non-sdk-interfaces

JSON representation
{"apiSignature":string,"invocationCount":integer,"list":enum (GreyList),"exampleStackTraces":[string],"insights":[{object (NonSdkApiInsight)}]}
Fields
apiSignature

string

The signature of the Non-SDK API

invocationCount

integer

The total number of times this API was observed to have been called.

list

enum (GreyList)

Which list this API appears on

exampleStackTraces[]

string

Example stack traces of this API being called.

insights[]

object (NonSdkApiInsight)

Optional debugging insights for non-SDK API violations.

NonSdkApiInsight

Non-SDK API insights (to address debugging solutions).

JSON representation
{"matcherId":string,"exampleTraceMessages":[string],// Union fieldinsight can be only one of the following:"upgradeInsight":{object (UpgradeInsight)},"pendingGoogleUpdateInsight":{object (PendingGoogleUpdateInsight)}// End of list of possible types for union fieldinsight.}
Fields
matcherId

string

A unique ID, to be used for determining the effectiveness of this particular insight in the context of a matcher. (required)

exampleTraceMessages[]

string

Optional sample stack traces, for which this insight applies (there should be at least one).

Union fieldinsight.

insight can be only one of the following:

upgradeInsight

object (UpgradeInsight)

An insight indicating that the hidden API usage originates from the use of a library that needs to be upgraded.

pendingGoogleUpdateInsight

object (PendingGoogleUpdateInsight)

An insight indicating that the hidden API usage originates from a Google-provided library.

UpgradeInsight

This insight is a recommendation to upgrade a given library to the specified version, in order to avoid dependencies on non-SDK APIs.

JSON representation
{"packageName":string,"upgradeToVersion":string}
Fields
packageName

string

The name of the package to be upgraded.

upgradeToVersion

string

The suggested version to upgrade to. Optional: In case we are not sure which version solves this problem

PendingGoogleUpdateInsight

This insight indicates that the hidden API usage originates from a Google-provided library. Users need not take any action.

JSON representation
{"nameOfGoogleLibrary":string}
Fields
nameOfGoogleLibrary

string

The name of the Google-provided library with the non-SDK API dependency.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-07-24 UTC.