playintegrity
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package playintegrity provides access to the Google Play Integrity API.
For product documentation, see:https://developer.android.com/google/play/integrity
Library status¶
These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.
When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.
Creating a client¶
Usage example:
import "google.golang.org/api/playintegrity/v1"...ctx := context.Background()playintegrityService, err := playintegrity.NewService(ctx)
In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options¶
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:
playintegrityService, err := playintegrity.NewService(ctx, option.WithAPIKey("AIza..."))To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)playintegrityService, err := playintegrity.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- Constants
- type AccountActivity
- type AccountDetails
- type AppAccessRiskVerdict
- type AppIntegrity
- type DecodeIntegrityTokenRequest
- type DecodeIntegrityTokenResponse
- type DecodePcIntegrityTokenRequest
- type DecodePcIntegrityTokenResponse
- type DeviceAttributes
- type DeviceIntegrity
- type DeviceRecall
- type DeviceRecallService
- type DeviceRecallWriteCall
- func (c *DeviceRecallWriteCall) Context(ctx context.Context) *DeviceRecallWriteCall
- func (c *DeviceRecallWriteCall) Do(opts ...googleapi.CallOption) (*WriteDeviceRecallResponse, error)
- func (c *DeviceRecallWriteCall) Fields(s ...googleapi.Field) *DeviceRecallWriteCall
- func (c *DeviceRecallWriteCall) Header() http.Header
- type EnvironmentDetails
- type PcAccountDetails
- type PcDeviceIntegrity
- type PcRequestDetails
- type PcTestingDetails
- type PcTokenPayloadExternal
- type RecentDeviceActivity
- type RequestDetails
- type Service
- type TestingDetails
- type TokenPayloadExternal
- type V1DecodeIntegrityTokenCall
- func (c *V1DecodeIntegrityTokenCall) Context(ctx context.Context) *V1DecodeIntegrityTokenCall
- func (c *V1DecodeIntegrityTokenCall) Do(opts ...googleapi.CallOption) (*DecodeIntegrityTokenResponse, error)
- func (c *V1DecodeIntegrityTokenCall) Fields(s ...googleapi.Field) *V1DecodeIntegrityTokenCall
- func (c *V1DecodeIntegrityTokenCall) Header() http.Header
- type V1DecodePcIntegrityTokenCall
- func (c *V1DecodePcIntegrityTokenCall) Context(ctx context.Context) *V1DecodePcIntegrityTokenCall
- func (c *V1DecodePcIntegrityTokenCall) Do(opts ...googleapi.CallOption) (*DecodePcIntegrityTokenResponse, error)
- func (c *V1DecodePcIntegrityTokenCall) Fields(s ...googleapi.Field) *V1DecodePcIntegrityTokenCall
- func (c *V1DecodePcIntegrityTokenCall) Header() http.Header
- type V1Service
- type Values
- type WriteDates
- type WriteDeviceRecallRequest
- type WriteDeviceRecallResponse
Constants¶
const (// Private Service:https://www.googleapis.com/auth/playintegrityPlayintegrityScope = "https://www.googleapis.com/auth/playintegrity")OAuth2 scopes used by this API.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeAccountActivity¶added inv0.100.0
type AccountActivity struct {// ActivityLevel: Required. Indicates the activity level of the account.//// Possible values:// "ACTIVITY_LEVEL_UNSPECIFIED" - Activity level has not been set.// "UNEVALUATED" - Account activity level is not evaluated.// "UNUSUAL" - Unusual activity for at least one of the user accounts on the// device.// "UNKNOWN" - Insufficient activity to verify the user account on the// device.// "TYPICAL_BASIC" - Typical activity for the user account or accounts on the// device.// "TYPICAL_STRONG" - Typical for the user account or accounts on the device,// with harder to replicate signals.ActivityLevelstring `json:"activityLevel,omitempty"`// ForceSendFields is a list of field names (e.g. "ActivityLevel") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActivityLevel") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}AccountActivity: (Restricted Access) Contains a signal helping appsdifferentiating between likely genuine and likely non-genuine user traffic.
func (AccountActivity)MarshalJSON¶added inv0.100.0
func (sAccountActivity) MarshalJSON() ([]byte,error)
typeAccountDetails¶
type AccountDetails struct {// AccountActivity: (Restricted Access) Details about the account activity for// the user in the scope.AccountActivity *AccountActivity `json:"accountActivity,omitempty"`// AppLicensingVerdict: Required. Details about the licensing status of the// user for the app in the scope.//// Possible values:// "UNKNOWN" - Play does not have sufficient information to evaluate// licensing details// "LICENSED" - The user has a valid license to use the app.// "UNLICENSED" - The user does not have a valid license to use the app.// "UNEVALUATED" - Licensing details were not evaluated since a necessary// requirement was missed. For example DeviceIntegrity did not meet the minimum// bar or the application was not a known Play version.AppLicensingVerdictstring `json:"appLicensingVerdict,omitempty"`// ForceSendFields is a list of field names (e.g. "AccountActivity") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccountActivity") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}AccountDetails: Contains the account information such as the licensingstatus for the user in the scope.
func (AccountDetails)MarshalJSON¶
func (sAccountDetails) MarshalJSON() ([]byte,error)
typeAppAccessRiskVerdict¶added inv0.151.0
type AppAccessRiskVerdict struct {// AppsDetected: List of detected app types signalled for App Access Risk.//// Possible values:// "APPS_DETECTED_UNSPECIFIED" - Apps detected is unspecified.// "KNOWN_INSTALLED" - One or more apps is installed by Google Play or// preloaded on the system partition by the device manufacturer.// "KNOWN_CAPTURING" - One or more apps installed by Google Play or preloaded// on the device is running that could be used to read or capture the// requesting app, such as a screen recording app.// "KNOWN_OVERLAYS" - One or more apps installed by Google Play or preloaded// on the device is running that could be used to display overlays over the// requesting app.// "KNOWN_CONTROLLING" - One or more apps installed by Google Play or// preloaded on the device is running that could be used to control the device,// such as a remote support app.// "UNKNOWN_INSTALLED" - One or more unknown apps is installed, that were not// installed by Google Play or preloaded on the system partition by the device// manufacturer.// "UNKNOWN_CAPTURING" - One or more unknown apps, which were not installed// by Google Play or preloaded on the device, is running that could be used to// read or capture the requesting app, such as a screen recording app.// "UNKNOWN_OVERLAYS" - One or more unknown apps, which were not installed by// Google Play or preloaded on the device, is running that could be used to// display overlays over the requesting app.// "UNKNOWN_CONTROLLING" - One or more unknown apps, which were not installed// by Google Play or preloaded on the device, is running that could be used to// control the device, such as a remote support app.AppsDetected []string `json:"appsDetected,omitempty"`// ForceSendFields is a list of field names (e.g. "AppsDetected") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AppsDetected") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}AppAccessRiskVerdict: Contains signals about others apps on the device whichcould be used to access or control the requesting app.
func (AppAccessRiskVerdict)MarshalJSON¶added inv0.151.0
func (sAppAccessRiskVerdict) MarshalJSON() ([]byte,error)
typeAppIntegrity¶
type AppIntegrity struct {// AppRecognitionVerdict: Required. Details about the app recognition verdict//// Possible values:// "UNKNOWN" - Play does not have sufficient information to evaluate app// integrity// "PLAY_RECOGNIZED" - The app and certificate match the versions distributed// by Play.// "UNRECOGNIZED_VERSION" - The certificate or package name does not match// Google Play records.// "UNEVALUATED" - Application integrity was not evaluated since a necessary// requirement was missed. For example DeviceIntegrity did not meet the minimum// bar.AppRecognitionVerdictstring `json:"appRecognitionVerdict,omitempty"`// CertificateSha256Digest: The SHA256 hash of the requesting app's signing// certificates (base64 web-safe encoded). Set iff app_recognition_verdict !=// UNEVALUATED.CertificateSha256Digest []string `json:"certificateSha256Digest,omitempty"`// PackageName: Package name of the application under attestation. Set iff// app_recognition_verdict != UNEVALUATED.PackageNamestring `json:"packageName,omitempty"`// VersionCode: Version code of the application. Set iff// app_recognition_verdict != UNEVALUATED.VersionCodeint64 `json:"versionCode,omitempty,string"`// ForceSendFields is a list of field names (e.g. "AppRecognitionVerdict") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AppRecognitionVerdict") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}AppIntegrity: Contains the application integrity information.
func (AppIntegrity)MarshalJSON¶
func (sAppIntegrity) MarshalJSON() ([]byte,error)
typeDecodeIntegrityTokenRequest¶
type DecodeIntegrityTokenRequest struct {// IntegrityToken: Encoded integrity token.IntegrityTokenstring `json:"integrityToken,omitempty"`// ForceSendFields is a list of field names (e.g. "IntegrityToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IntegrityToken") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DecodeIntegrityTokenRequest: Request to decode the integrity token.
func (DecodeIntegrityTokenRequest)MarshalJSON¶
func (sDecodeIntegrityTokenRequest) MarshalJSON() ([]byte,error)
typeDecodeIntegrityTokenResponse¶
type DecodeIntegrityTokenResponse struct {// TokenPayloadExternal: Plain token payload generated from the decoded// integrity token.TokenPayloadExternal *TokenPayloadExternal `json:"tokenPayloadExternal,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "TokenPayloadExternal") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "TokenPayloadExternal") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DecodeIntegrityTokenResponse: Response containing the decoded integritypayload.
func (DecodeIntegrityTokenResponse)MarshalJSON¶
func (sDecodeIntegrityTokenResponse) MarshalJSON() ([]byte,error)
typeDecodePcIntegrityTokenRequest¶added inv0.234.0
type DecodePcIntegrityTokenRequest struct {// IntegrityToken: Encoded integrity token.IntegrityTokenstring `json:"integrityToken,omitempty"`// ForceSendFields is a list of field names (e.g. "IntegrityToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IntegrityToken") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DecodePcIntegrityTokenRequest: Request to decode the PC integrity token.
func (DecodePcIntegrityTokenRequest)MarshalJSON¶added inv0.234.0
func (sDecodePcIntegrityTokenRequest) MarshalJSON() ([]byte,error)
typeDecodePcIntegrityTokenResponse¶added inv0.234.0
type DecodePcIntegrityTokenResponse struct {// TokenPayloadExternal: Plain token payload generated from the decoded// integrity token.TokenPayloadExternal *PcTokenPayloadExternal `json:"tokenPayloadExternal,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "TokenPayloadExternal") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "TokenPayloadExternal") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DecodePcIntegrityTokenResponse: Response containing the decoded PC integritypayload.
func (DecodePcIntegrityTokenResponse)MarshalJSON¶added inv0.234.0
func (sDecodePcIntegrityTokenResponse) MarshalJSON() ([]byte,error)
typeDeviceAttributes¶added inv0.209.0
type DeviceAttributes struct {// SdkVersion: Android SDK version of the device, as defined in the public// Android documentation://https://developer.android.com/reference/android/os/Build.VERSION_CODES. It// won't be set if a necessary requirement was missed. For example// DeviceIntegrity did not meet the minimum bar.SdkVersionint64 `json:"sdkVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "SdkVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SdkVersion") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DeviceAttributes: Contains information about the device for which theintegrity token was generated, e.g. Android SDK version.
func (DeviceAttributes)MarshalJSON¶added inv0.209.0
func (sDeviceAttributes) MarshalJSON() ([]byte,error)
typeDeviceIntegrity¶
type DeviceIntegrity struct {// DeviceAttributes: Attributes of the device where the integrity token was// generated.DeviceAttributes *DeviceAttributes `json:"deviceAttributes,omitempty"`// DeviceRecall: Details about the device recall bits set by the developer.DeviceRecall *DeviceRecall `json:"deviceRecall,omitempty"`// DeviceRecognitionVerdict: Details about the integrity of the device the app// is running on.//// Possible values:// "UNKNOWN" - Play does not have sufficient information to evaluate device// integrity// "MEETS_BASIC_INTEGRITY" - App is running on a device that passes basic// system integrity checks, but may not meet Android platform compatibility// requirements and may not be approved to run Google Play services.// "MEETS_DEVICE_INTEGRITY" - App is running on GMS Android device with// Google Play services.// "MEETS_STRONG_INTEGRITY" - App is running on GMS Android device with// Google Play services and has a strong guarantee of system integrity such as// a hardware-backed keystore.// "MEETS_VIRTUAL_INTEGRITY" - App is running on an Android emulator with// Google Play services which meets core Android compatibility requirements.DeviceRecognitionVerdict []string `json:"deviceRecognitionVerdict,omitempty"`// LegacyDeviceRecognitionVerdict: Contains legacy details about the integrity// of the device the app is running on. Only for devices with Android version T// or higher and only for apps opted in to the new verdicts. Only available// during the transition period to the new verdicts system and will be removed// afterwards.//// Possible values:// "UNKNOWN" - Play does not have sufficient information to evaluate device// integrity// "MEETS_BASIC_INTEGRITY" - App is running on a device that passes basic// system integrity checks, but may not meet Android platform compatibility// requirements and may not be approved to run Google Play services.// "MEETS_DEVICE_INTEGRITY" - App is running on GMS Android device with// Google Play services.// "MEETS_STRONG_INTEGRITY" - App is running on GMS Android device with// Google Play services and has a strong guarantee of system integrity such as// a hardware-backed keystore.// "MEETS_VIRTUAL_INTEGRITY" - App is running on an Android emulator with// Google Play services which meets core Android compatibility requirements.LegacyDeviceRecognitionVerdict []string `json:"legacyDeviceRecognitionVerdict,omitempty"`// RecentDeviceActivity: Details about the device activity of the device the// app is running on.RecentDeviceActivity *RecentDeviceActivity `json:"recentDeviceActivity,omitempty"`// ForceSendFields is a list of field names (e.g. "DeviceAttributes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DeviceAttributes") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DeviceIntegrity: Contains the device attestation information.
func (DeviceIntegrity)MarshalJSON¶
func (sDeviceIntegrity) MarshalJSON() ([]byte,error)
typeDeviceRecall¶added inv0.190.0
type DeviceRecall struct {// Values: Required. Contains the recall bits values.Values *Values `json:"values,omitempty"`// WriteDates: Required. Contains the recall bits write dates.WriteDates *WriteDates `json:"writeDates,omitempty"`// ForceSendFields is a list of field names (e.g. "Values") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Values") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DeviceRecall: Contains the recall bits per device set by the developer.
func (DeviceRecall)MarshalJSON¶added inv0.190.0
func (sDeviceRecall) MarshalJSON() ([]byte,error)
typeDeviceRecallService¶added inv0.189.0
type DeviceRecallService struct {// contains filtered or unexported fields}funcNewDeviceRecallService¶added inv0.189.0
func NewDeviceRecallService(s *Service) *DeviceRecallService
func (*DeviceRecallService)Write¶added inv0.189.0
func (r *DeviceRecallService) Write(packageNamestring, writedevicerecallrequest *WriteDeviceRecallRequest) *DeviceRecallWriteCall
Write: Writes recall bits for the device where Play Integrity API token isobtained. The endpoint is available to select Play partners in an earlyaccess program (EAP).
- packageName: Package name of the app the attached integrity token belongsto.
typeDeviceRecallWriteCall¶added inv0.189.0
type DeviceRecallWriteCall struct {// contains filtered or unexported fields}func (*DeviceRecallWriteCall)Context¶added inv0.189.0
func (c *DeviceRecallWriteCall) Context(ctxcontext.Context) *DeviceRecallWriteCall
Context sets the context to be used in this call's Do method.
func (*DeviceRecallWriteCall)Do¶added inv0.189.0
func (c *DeviceRecallWriteCall) Do(opts ...googleapi.CallOption) (*WriteDeviceRecallResponse,error)
Do executes the "playintegrity.deviceRecall.write" call.Any non-2xx status code is an error. Response headers are in either*WriteDeviceRecallResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*DeviceRecallWriteCall)Fields¶added inv0.189.0
func (c *DeviceRecallWriteCall) Fields(s ...googleapi.Field) *DeviceRecallWriteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*DeviceRecallWriteCall)Header¶added inv0.189.0
func (c *DeviceRecallWriteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeEnvironmentDetails¶added inv0.151.0
type EnvironmentDetails struct {// AppAccessRiskVerdict: The evaluation of the App Access Risk verdicts.AppAccessRiskVerdict *AppAccessRiskVerdict `json:"appAccessRiskVerdict,omitempty"`// PlayProtectVerdict: The evaluation of Play Protect verdict.//// Possible values:// "PLAY_PROTECT_VERDICT_UNSPECIFIED" - Play Protect verdict has not been// set.// "UNEVALUATED" - Play Protect state was not evaluated. Device may not be// trusted.// "NO_ISSUES" - Play Protect is on and no issues found.// "NO_DATA" - Play Protect is on but no scan has been performed yet. The// device or Play Store app may have been reset.// "MEDIUM_RISK" - Play Protect is on and warnings found.// "HIGH_RISK" - Play Protect is on and high severity issues found.// "POSSIBLE_RISK" - Play Protect is turned off. Turn on Play Protect.PlayProtectVerdictstring `json:"playProtectVerdict,omitempty"`// ForceSendFields is a list of field names (e.g. "AppAccessRiskVerdict") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AppAccessRiskVerdict") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}EnvironmentDetails: Contains information about the environment PlayIntegrity API runs in, e.g. Play Protect verdict.
func (EnvironmentDetails)MarshalJSON¶added inv0.151.0
func (sEnvironmentDetails) MarshalJSON() ([]byte,error)
typePcAccountDetails¶added inv0.249.0
type PcAccountDetails struct {// AppLicensingVerdict: Required. Details about the licensing status of the// user for the app in the scope.//// Possible values:// "UNKNOWN" - Play does not have sufficient information to evaluate// licensing details// "LICENSED" - The user has a valid license to use the app.// "UNLICENSED" - The user does not have a valid license to use the app.// "UNEVALUATED" - Licensing details were not evaluated since a necessary// requirement was missed.AppLicensingVerdictstring `json:"appLicensingVerdict,omitempty"`// ForceSendFields is a list of field names (e.g. "AppLicensingVerdict") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AppLicensingVerdict") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PcAccountDetails: Contains the account information such as the licensingstatus for the user in the scope.
func (PcAccountDetails)MarshalJSON¶added inv0.249.0
func (sPcAccountDetails) MarshalJSON() ([]byte,error)
typePcDeviceIntegrity¶added inv0.234.0
type PcDeviceIntegrity struct {// DeviceRecognitionVerdict: Details about the integrity of the device the app// is running on.//// Possible values:// "DEVICE_RECOGNITION_VERDICT_UNSPECIFIED" - Unspecified device integrity.// "MEETS_PC_INTEGRITY" - App is running on Windows Device with Google// Desktop Services.DeviceRecognitionVerdict []string `json:"deviceRecognitionVerdict,omitempty"`// ForceSendFields is a list of field names (e.g. "DeviceRecognitionVerdict")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DeviceRecognitionVerdict") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PcDeviceIntegrity: Contains the device attestation information.
func (PcDeviceIntegrity)MarshalJSON¶added inv0.234.0
func (sPcDeviceIntegrity) MarshalJSON() ([]byte,error)
typePcRequestDetails¶added inv0.234.0
type PcRequestDetails struct {// RequestHash: Request hash that was provided in the request.RequestHashstring `json:"requestHash,omitempty"`// RequestPackageName: Required. Application package name this attestation was// requested for. Note: This field makes no guarantees or promises on the// caller integrity.RequestPackageNamestring `json:"requestPackageName,omitempty"`// RequestTime: Required. Timestamp, of the integrity application request.RequestTimestring `json:"requestTime,omitempty"`// ForceSendFields is a list of field names (e.g. "RequestHash") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "RequestHash") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PcRequestDetails: Contains the integrity request information.
func (PcRequestDetails)MarshalJSON¶added inv0.234.0
func (sPcRequestDetails) MarshalJSON() ([]byte,error)
typePcTestingDetails¶added inv0.249.0
type PcTestingDetails struct {// IsTestingResponse: Indicates that the information contained in this payload// is a testing response that is statically overridden for a tester.IsTestingResponsebool `json:"isTestingResponse,omitempty"`// ForceSendFields is a list of field names (e.g. "IsTestingResponse") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IsTestingResponse") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PcTestingDetails: Contains additional information generated for testingresponses.
func (PcTestingDetails)MarshalJSON¶added inv0.249.0
func (sPcTestingDetails) MarshalJSON() ([]byte,error)
typePcTokenPayloadExternal¶added inv0.234.0
type PcTokenPayloadExternal struct {// AccountDetails: Details about the account information such as the licensing// status.AccountDetails *PcAccountDetails `json:"accountDetails,omitempty"`// DeviceIntegrity: Required. Details about the device integrity.DeviceIntegrity *PcDeviceIntegrity `json:"deviceIntegrity,omitempty"`// RequestDetails: Required. Details about the integrity request.RequestDetails *PcRequestDetails `json:"requestDetails,omitempty"`// TestingDetails: Indicates that this payload is generated for testing// purposes and contains any additional data that is linked with testing// status.TestingDetails *PcTestingDetails `json:"testingDetails,omitempty"`// ForceSendFields is a list of field names (e.g. "AccountDetails") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccountDetails") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PcTokenPayloadExternal: Contains PC device attestation details.
func (PcTokenPayloadExternal)MarshalJSON¶added inv0.234.0
func (sPcTokenPayloadExternal) MarshalJSON() ([]byte,error)
typeRecentDeviceActivity¶added inv0.155.0
type RecentDeviceActivity struct {// DeviceActivityLevel: Required. Indicates the activity level of the device.//// Possible values:// "DEVICE_ACTIVITY_LEVEL_UNSPECIFIED" - Device activity level has not been// set.// "UNEVALUATED" - Device activity level has not been evaluated.// "LEVEL_1" - Indicates the amount of used tokens. See the documentation for// details.// "LEVEL_2" - Indicates the amount of used tokens. See the documentation for// details.// "LEVEL_3" - Indicates the amount of used tokens. See the documentation for// details.// "LEVEL_4" - Indicates the amount of used tokens. See the documentation for// details.DeviceActivityLevelstring `json:"deviceActivityLevel,omitempty"`// ForceSendFields is a list of field names (e.g. "DeviceActivityLevel") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DeviceActivityLevel") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}RecentDeviceActivity: Recent device activity can help developers identifydevices that have exhibited hyperactive attestation activity, which could bea sign of an attack or token farming.
func (RecentDeviceActivity)MarshalJSON¶added inv0.155.0
func (sRecentDeviceActivity) MarshalJSON() ([]byte,error)
typeRequestDetails¶
type RequestDetails struct {// Nonce: Nonce that was provided in the request (which is base64 web-safe// no-wrap).Noncestring `json:"nonce,omitempty"`// RequestHash: Request hash that was provided in the request.RequestHashstring `json:"requestHash,omitempty"`// RequestPackageName: Required. Application package name this attestation was// requested for. Note: This field makes no guarantees or promises on the// caller integrity. For details on application integrity, check// application_integrity.RequestPackageNamestring `json:"requestPackageName,omitempty"`// TimestampMillis: Required. Timestamp, in milliseconds, of the integrity// application request.TimestampMillisint64 `json:"timestampMillis,omitempty,string"`// ForceSendFields is a list of field names (e.g. "Nonce") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Nonce") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}RequestDetails: Contains the integrity request information.
func (RequestDetails)MarshalJSON¶
func (sRequestDetails) MarshalJSON() ([]byte,error)
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentDeviceRecall *DeviceRecallServiceV1 *V1Service// contains filtered or unexported fields} funcNewdeprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
funcNewService¶
NewService creates a new Service.
typeTestingDetails¶
type TestingDetails struct {// IsTestingResponse: Required. Indicates that the information contained in// this payload is a testing response that is statically overridden for a// tester.IsTestingResponsebool `json:"isTestingResponse,omitempty"`// ForceSendFields is a list of field names (e.g. "IsTestingResponse") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IsTestingResponse") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}TestingDetails: Contains additional information generated for testingresponses.
func (TestingDetails)MarshalJSON¶
func (sTestingDetails) MarshalJSON() ([]byte,error)
typeTokenPayloadExternal¶
type TokenPayloadExternal struct {// AccountDetails: Required. Details about the Play Store account.AccountDetails *AccountDetails `json:"accountDetails,omitempty"`// AppIntegrity: Required. Details about the application integrity.AppIntegrity *AppIntegrity `json:"appIntegrity,omitempty"`// DeviceIntegrity: Required. Details about the device integrity.DeviceIntegrity *DeviceIntegrity `json:"deviceIntegrity,omitempty"`// EnvironmentDetails: Details of the environment Play Integrity API runs in.EnvironmentDetails *EnvironmentDetails `json:"environmentDetails,omitempty"`// RequestDetails: Required. Details about the integrity request.RequestDetails *RequestDetails `json:"requestDetails,omitempty"`// TestingDetails: Indicates that this payload is generated for testing// purposes and contains any additional data that is linked with testing// status.TestingDetails *TestingDetails `json:"testingDetails,omitempty"`// ForceSendFields is a list of field names (e.g. "AccountDetails") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccountDetails") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}TokenPayloadExternal: Contains basic app information and integrity signalslike device attestation and licensing details.
func (TokenPayloadExternal)MarshalJSON¶
func (sTokenPayloadExternal) MarshalJSON() ([]byte,error)
typeV1DecodeIntegrityTokenCall¶
type V1DecodeIntegrityTokenCall struct {// contains filtered or unexported fields}func (*V1DecodeIntegrityTokenCall)Context¶
func (c *V1DecodeIntegrityTokenCall) Context(ctxcontext.Context) *V1DecodeIntegrityTokenCall
Context sets the context to be used in this call's Do method.
func (*V1DecodeIntegrityTokenCall)Do¶
func (c *V1DecodeIntegrityTokenCall) Do(opts ...googleapi.CallOption) (*DecodeIntegrityTokenResponse,error)
Do executes the "playintegrity.decodeIntegrityToken" call.Any non-2xx status code is an error. Response headers are in either*DecodeIntegrityTokenResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*V1DecodeIntegrityTokenCall)Fields¶
func (c *V1DecodeIntegrityTokenCall) Fields(s ...googleapi.Field) *V1DecodeIntegrityTokenCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*V1DecodeIntegrityTokenCall)Header¶
func (c *V1DecodeIntegrityTokenCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeV1DecodePcIntegrityTokenCall¶added inv0.234.0
type V1DecodePcIntegrityTokenCall struct {// contains filtered or unexported fields}func (*V1DecodePcIntegrityTokenCall)Context¶added inv0.234.0
func (c *V1DecodePcIntegrityTokenCall) Context(ctxcontext.Context) *V1DecodePcIntegrityTokenCall
Context sets the context to be used in this call's Do method.
func (*V1DecodePcIntegrityTokenCall)Do¶added inv0.234.0
func (c *V1DecodePcIntegrityTokenCall) Do(opts ...googleapi.CallOption) (*DecodePcIntegrityTokenResponse,error)
Do executes the "playintegrity.decodePcIntegrityToken" call.Any non-2xx status code is an error. Response headers are in either*DecodePcIntegrityTokenResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*V1DecodePcIntegrityTokenCall)Fields¶added inv0.234.0
func (c *V1DecodePcIntegrityTokenCall) Fields(s ...googleapi.Field) *V1DecodePcIntegrityTokenCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*V1DecodePcIntegrityTokenCall)Header¶added inv0.234.0
func (c *V1DecodePcIntegrityTokenCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeV1Service¶
type V1Service struct {// contains filtered or unexported fields}funcNewV1Service¶
func (*V1Service)DecodeIntegrityToken¶
func (r *V1Service) DecodeIntegrityToken(packageNamestring, decodeintegritytokenrequest *DecodeIntegrityTokenRequest) *V1DecodeIntegrityTokenCall
DecodeIntegrityToken: Decodes the integrity token and returns the tokenpayload.
- packageName: Package name of the app the attached integrity token belongsto.
func (*V1Service)DecodePcIntegrityToken¶added inv0.234.0
func (r *V1Service) DecodePcIntegrityToken(packageNamestring, decodepcintegritytokenrequest *DecodePcIntegrityTokenRequest) *V1DecodePcIntegrityTokenCall
DecodePcIntegrityToken: Decodes the PC integrity token and returns the PCtoken payload.
- packageName: Package name of the app the attached integrity token belongsto.
typeValues¶added inv0.189.0
type Values struct {// BitFirst: Required. First recall bit value.BitFirstbool `json:"bitFirst,omitempty"`// BitSecond: Required. Second recall bit value.BitSecondbool `json:"bitSecond,omitempty"`// BitThird: Required. Third recall bit value.BitThirdbool `json:"bitThird,omitempty"`// ForceSendFields is a list of field names (e.g. "BitFirst") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BitFirst") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Values: Contains the recall bits values.
func (Values)MarshalJSON¶added inv0.189.0
typeWriteDates¶added inv0.190.0
type WriteDates struct {// YyyymmFirst: Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for// the first bit. Note that this value won't be set if the first bit is false.YyyymmFirstint64 `json:"yyyymmFirst,omitempty"`// YyyymmSecond: Optional. Write time in YYYYMM format (in UTC, e.g. 202402)// for the second bit. Note that this value won't be set if the second bit is// false.YyyymmSecondint64 `json:"yyyymmSecond,omitempty"`// YyyymmThird: Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for// the third bit. Note that this value won't be set if the third bit is false.YyyymmThirdint64 `json:"yyyymmThird,omitempty"`// ForceSendFields is a list of field names (e.g. "YyyymmFirst") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "YyyymmFirst") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}WriteDates: Contains the recall bits write dates.
func (WriteDates)MarshalJSON¶added inv0.190.0
func (sWriteDates) MarshalJSON() ([]byte,error)
typeWriteDeviceRecallRequest¶added inv0.189.0
type WriteDeviceRecallRequest struct {// IntegrityToken: Required. Integrity token obtained from calling Play// Integrity API.IntegrityTokenstring `json:"integrityToken,omitempty"`// NewValues: Required. The new values for the device recall bits to be// written.NewValues *Values `json:"newValues,omitempty"`// ForceSendFields is a list of field names (e.g. "IntegrityToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IntegrityToken") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}WriteDeviceRecallRequest: Request to write device recall bits.
func (WriteDeviceRecallRequest)MarshalJSON¶added inv0.189.0
func (sWriteDeviceRecallRequest) MarshalJSON() ([]byte,error)
typeWriteDeviceRecallResponse¶added inv0.189.0
type WriteDeviceRecallResponse struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}WriteDeviceRecallResponse: Response for the Write Device Recall action.Currently empty.