Barcode
Stay organized with collections
Save and categorize content based on your preferences.
| Fields |
kind
(deprecated) |
string
Identifies what kind of resource this is. Value: the fixed string "walletobjects#barcode".
|
type |
enum (BarcodeType)
The type of barcode.
|
renderEncoding |
enum (BarcodeRenderEncoding)
The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
|
value |
string
The value encoded in the barcode.
|
alternateText |
string
An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
|
showCodeText |
object (LocalizedString)
Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
|
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\u003eBarcodes in Google Wallet can be customized with type, rendering encoding, value, alternate text, and display settings for code text.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ekind\u003c/code\u003e field is deprecated and should no longer be used.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eshowCodeText\u003c/code\u003e field controls text display when the barcode is hidden, often due to Smart Tap.\u003c/p\u003e\n"],["\u003cp\u003eBarcode values can include an optional human-readable \u003ccode\u003ealternateText\u003c/code\u003e for accessibility.\u003c/p\u003e\n"]]],["The core content describes the structure and fields of a barcode in a JSON format. Key information includes: `type` specifying the barcode type, `renderEncoding` defining how the barcode is rendered, and `value` containing the encoded data. `alternateText` provides a human-readable alternative, while `showCodeText` offers optional text when the barcode is hidden. The `kind` field is deprecated. The document describes each field's data type.\n"],null,["# Barcode\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"type\": enum (/wallet/reference/rest/v1/BarcodeType), \"renderEncoding\": enum (/wallet/reference/rest/v1/BarcodeRenderEncoding), \"value\": string, \"alternateText\": string, \"showCodeText\": { object (/wallet/reference/rest/v1/LocalizedString) } } ``` |\n\n| Fields ||\n|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` **(deprecated)** | `string` | This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `\"walletobjects#barcode\"`. |\n| `type` | `enum (`[BarcodeType](/wallet/reference/rest/v1/BarcodeType)`)` The type of barcode. |\n| `renderEncoding` | `enum (`[BarcodeRenderEncoding](/wallet/reference/rest/v1/BarcodeRenderEncoding)`)` The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google. |\n| `value` | `string` The value encoded in the barcode. |\n| `alternateText` | `string` An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned. |\n| `showCodeText` | `object (`[LocalizedString](/wallet/reference/rest/v1/LocalizedString)`)` Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google. |"]]
