PassConstraints
Stay organized with collections
Save and categorize content based on your preferences.
Container for any constraints that may be placed on passes.
ScreenshotEligibility
Defines if/how screenshots may be taken of a pass.
| Enums |
SCREENSHOT_ELIGIBILITY_UNSPECIFIED |
Default value, same as ELIGIBLE. |
ELIGIBLE |
Default behavior for all existing Passes if ScreenshotEligibility is not set. Allows screenshots to be taken on Android devices. |
INELIGIBLE |
Disallows screenshots to be taken on Android devices. Note that older versions of Wallet may still allow screenshots to be taken. |
NfcConstraint
Defines possible NFC constraints for the pass.
| Enums |
NFC_CONSTRAINT_UNSPECIFIED |
Default value, no specified constraint. |
BLOCK_PAYMENT |
Payment cards will not be conveyed while the pass is open. |
BLOCK_CLOSED_LOOP_TRANSIT |
Closed loop transit cards will not be conveyed while the pass is open. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-13 UTC.
[null,null,["Last updated 2025-03-13 UTC."],[[["\u003cp\u003ePass constraints can be set to control screenshot eligibility and NFC behavior.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003escreenshotEligibility\u003c/code\u003e determines if screenshots of the pass are allowed on Android devices, with options for eligible or ineligible.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003enfcConstraint\u003c/code\u003e allows restrictions on NFC interactions when the pass is open, such as blocking payments or closed-loop transit cards.\u003c/p\u003e\n"],["\u003cp\u003eThe default behavior for screenshots is eligible, and there are no NFC constraints by default.\u003c/p\u003e\n"]]],["Pass constraints are defined through `screenshotEligibility` and `nfcConstraint`. `screenshotEligibility` controls screenshot capture with `ELIGIBLE` (default) or `INELIGIBLE` options. `nfcConstraint` manages NFC interactions, allowing `BLOCK_PAYMENT` to prevent payment card conveyance and `BLOCK_CLOSED_LOOP_TRANSIT` to block closed-loop transit card conveyance. Unspecified settings use default behaviors: `SCREENSHOT_ELIGIBILITY_UNSPECIFIED` defaults to `ELIGIBLE` and `NFC_CONSTRAINT_UNSPECIFIED` implies no constraints.\n"],null,["# PassConstraints\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [ScreenshotEligibility](#ScreenshotEligibility)\n- [NfcConstraint](#NfcConstraint)\n\nContainer for any constraints that may be placed on passes.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"screenshotEligibility\": enum (/wallet/reference/rest/v1/PassConstraints#ScreenshotEligibility), \"nfcConstraint\": [ enum (/wallet/reference/rest/v1/PassConstraints#NfcConstraint) ] } ``` |\n\n| Fields ||\n|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|\n| `screenshotEligibility` | `enum (`[ScreenshotEligibility](/wallet/reference/rest/v1/PassConstraints#ScreenshotEligibility)`)` The screenshot eligibility for the pass. |\n| `nfcConstraint[]` | `enum (`[NfcConstraint](/wallet/reference/rest/v1/PassConstraints#NfcConstraint)`)` The NFC constraints for the pass. |\n\nScreenshotEligibility\n---------------------\n\nDefines if/how screenshots may be taken of a pass.\n\n| Enums ||\n|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `SCREENSHOT_ELIGIBILITY_UNSPECIFIED` | Default value, same as ELIGIBLE. |\n| `ELIGIBLE` | Default behavior for all existing Passes if ScreenshotEligibility is not set. Allows screenshots to be taken on Android devices. |\n| `INELIGIBLE` | Disallows screenshots to be taken on Android devices. Note that older versions of Wallet may still allow screenshots to be taken. |\n\nNfcConstraint\n-------------\n\nDefines possible NFC constraints for the pass.\n\n| Enums ||\n|------------------------------|------------------------------------------------------------------------|\n| `NFC_CONSTRAINT_UNSPECIFIED` | Default value, no specified constraint. |\n| `BLOCK_PAYMENT` | Payment cards will not be conveyed while the pass is open. |\n| `BLOCK_CLOSED_LOOP_TRANSIT` | Closed loop transit cards will not be conveyed while the pass is open. |"]]
