play_integrity_config

Creates, updates, deletes, gets or lists a play_integrity_config resource.

Overview

Name	play_integrity_config
Type	Resource
Id	firebase.appcheck.play_integrity_config

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Required. The relative resource name of the Play Integrity configuration object, in the format: projects/{project_number}/apps/{app_id}/playIntegrityConfig
accountDetails	object	Specifies account requirements for Android devices running your app. These settings correspond to requirements on the account details field obtained from the Play Integrity API. See the default responses table for a quick summary. The default values for these settings work for most apps, and are recommended. (id: GoogleFirebaseAppcheckV1PlayIntegrityConfigAccountDetails)
appIntegrity	object	Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the application integrity field obtained from the Play Integrity API. See the default responses table for a quick summary. The default values for these settings work for most apps, and are recommended. (id: GoogleFirebaseAppcheckV1PlayIntegrityConfigAppIntegrity)
deviceIntegrity	object	Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the device integrity field obtained from the Play Integrity API. See the default responses table for a quick summary. Warning: There are also conditional as well as optional responses that you can receive, but requires additional explicit opt-in from you. The App Check API is not responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. (id: GoogleFirebaseAppcheckV1PlayIntegrityConfigDeviceIntegrity)
tokenTtl	string (google-duration)	Specifies the duration for which App Check tokens exchanged from Play Integrity tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.

batch_get

Name	Datatype	Description
configs	array	PlayIntegrityConfigs retrieved.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, appsId		Gets the PlayIntegrityConfig for the specified app.
batch_get	select	projectsId	names	Atomically gets the PlayIntegrityConfigs for the specified list of apps.
patch	update	projectsId, appsId	updateMask	Updates the PlayIntegrityConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange Play Integrity tokens for App Check tokens.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
appsId	string
projectsId	string
names	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the PlayIntegrityConfig for the specified app.

SELECT
name,
accountDetails,
appIntegrity,
deviceIntegrity,
tokenTtl
FROM firebase.appcheck.play_integrity_config
WHERE projectsId = '{{ projectsId }}' -- required
AND appsId = '{{ appsId }}' -- required
;

batch_get

Atomically gets the PlayIntegrityConfigs for the specified list of apps.

SELECT
configs
FROM firebase.appcheck.play_integrity_config
WHERE projectsId = '{{ projectsId }}' -- required
AND names = '{{ names }}'
;

UPDATE examples

patch

Updates the PlayIntegrityConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange Play Integrity tokens for App Check tokens.

UPDATE firebase.appcheck.play_integrity_config
SET 
data__tokenTtl = '{{ tokenTtl }}',
data__name = '{{ name }}',
data__deviceIntegrity = '{{ deviceIntegrity }}',
data__appIntegrity = '{{ appIntegrity }}',
data__accountDetails = '{{ accountDetails }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND appsId = '{{ appsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
accountDetails,
appIntegrity,
deviceIntegrity,
tokenTtl;