addmessage(resourceId, body=None, x__xgafv=None)
Adds a message to the gift card object referenced by the given object ID.
Close httplib2 connections.
get(resourceId, x__xgafv=None)
Returns the gift card object with the given object ID.
insert(body=None, x__xgafv=None)
Inserts an gift card object with the given ID and properties.
list(classId=None, maxResults=None, token=None, x__xgafv=None)
Returns a list of all gift card objects for a given issuer ID.
patch(resourceId, body=None, x__xgafv=None)
Updates the gift card object referenced by the given object ID. This method supports patch semantics.
update(resourceId, body=None, x__xgafv=None)
Updates the gift card object referenced by the given object ID.
addmessage(resourceId, body=None, x__xgafv=None)
Adds a message to the gift card object referenced by the given object ID.
Args:
resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
body: object, The request body.
The object takes the form of:
{ # Resource used when the AddMessage endpoints are called.
"message": { # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"resource": { # The updated GiftCardObject resource.
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"balance": { # The card's monetary balance.
"currencyCode": "A String", # The currency code, such as "USD" or "EUR."
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
"micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
},
"balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"barcode": { # The barcode type and value.
"alternateText": "A 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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"type": "A String", # The type of barcode.
"value": "A String", # The value encoded in the barcode.
},
"cardNumber": "A String", # Required. The card's number.
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
"cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
"classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
"cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
"firstBottomDetail": { # Optional information to display below the barcode.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"cardTemplateOverride": { # Override for the card view.
"cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
"oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
"item": { # The item to be displayed in the row. This item will be automatically centered.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
},
],
},
"detailsTemplateOverride": { # Override for the details view (beneath the card view).
"detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
{
"item": { # The item to be displayed in the details list.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
],
},
"listTemplateOverride": { # Override for the passes list view.
"firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
"fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"transitOption": "A String",
},
"secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
"enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
"homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
"id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
"linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"localizedCardNumberLabel": { # Translated strings for the card_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedEventNumberLabel": { # Translated strings for the event_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedPinLabel": { # Translated strings for the pin_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
"notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
"programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
"review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
"comments": "A String",
},
"reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
"securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
"animationType": "A String", # Type of animation.
},
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
"viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
"wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
"disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
"eventNumber": "A String", # The card's event number, an optional field used by some gift cards.
"groupingInfo": { # Information that controls how passes are grouped together.
"groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
"sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
},
"hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
"hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`.
"linkedObjectIds": [ # linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
"A String",
],
"linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
"nfcConstraint": [ # The NFC constraints for the pass.
"A String",
],
"screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
"pin": "A String", # The card's PIN.
"rotatingBarcode": { # The rotating barcode type and value.
"alternateText": "A 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.
"initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
"periodMillis": "A String", # Required. The amount of time each barcode is valid for.
"startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
"values": [ # Required. The values to encode in the barcode. At least one value is required.
"A String",
],
},
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
"algorithm": "A String", # The TOTP algorithm used to generate the OTP.
"parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
{ # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
"key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
"valueLength": 42, # The length of the TOTP value in decimal digits.
},
],
"periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
"type": "A String", # The type of this barcode.
"valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
"saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
"restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
},
"smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
"state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
},
}
close()
Close httplib2 connections.
get(resourceId, x__xgafv=None)
Returns the gift card object with the given object ID.
Args:
resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"balance": { # The card's monetary balance.
"currencyCode": "A String", # The currency code, such as "USD" or "EUR."
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
"micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
},
"balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"barcode": { # The barcode type and value.
"alternateText": "A 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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"type": "A String", # The type of barcode.
"value": "A String", # The value encoded in the barcode.
},
"cardNumber": "A String", # Required. The card's number.
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
"cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
"classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
"cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
"firstBottomDetail": { # Optional information to display below the barcode.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"cardTemplateOverride": { # Override for the card view.
"cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
"oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
"item": { # The item to be displayed in the row. This item will be automatically centered.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
},
],
},
"detailsTemplateOverride": { # Override for the details view (beneath the card view).
"detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
{
"item": { # The item to be displayed in the details list.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
],
},
"listTemplateOverride": { # Override for the passes list view.
"firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
"fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"transitOption": "A String",
},
"secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
"enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
"homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
"id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
"linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"localizedCardNumberLabel": { # Translated strings for the card_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedEventNumberLabel": { # Translated strings for the event_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedPinLabel": { # Translated strings for the pin_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
"notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
"programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
"review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
"comments": "A String",
},
"reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
"securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
"animationType": "A String", # Type of animation.
},
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
"viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
"wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
"disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
"eventNumber": "A String", # The card's event number, an optional field used by some gift cards.
"groupingInfo": { # Information that controls how passes are grouped together.
"groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
"sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
},
"hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
"hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`.
"linkedObjectIds": [ # linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
"A String",
],
"linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
"nfcConstraint": [ # The NFC constraints for the pass.
"A String",
],
"screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
"pin": "A String", # The card's PIN.
"rotatingBarcode": { # The rotating barcode type and value.
"alternateText": "A 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.
"initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
"periodMillis": "A String", # Required. The amount of time each barcode is valid for.
"startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
"values": [ # Required. The values to encode in the barcode. At least one value is required.
"A String",
],
},
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
"algorithm": "A String", # The TOTP algorithm used to generate the OTP.
"parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
{ # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
"key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
"valueLength": 42, # The length of the TOTP value in decimal digits.
},
],
"periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
"type": "A String", # The type of this barcode.
"valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
"saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
"restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
},
"smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
"state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
}
insert(body=None, x__xgafv=None)
Inserts an gift card object with the given ID and properties.
Args:
body: object, The request body.
The object takes the form of:
{
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"balance": { # The card's monetary balance.
"currencyCode": "A String", # The currency code, such as "USD" or "EUR."
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
"micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
},
"balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"barcode": { # The barcode type and value.
"alternateText": "A 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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"type": "A String", # The type of barcode.
"value": "A String", # The value encoded in the barcode.
},
"cardNumber": "A String", # Required. The card's number.
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
"cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
"classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
"cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
"firstBottomDetail": { # Optional information to display below the barcode.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"cardTemplateOverride": { # Override for the card view.
"cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
"oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
"item": { # The item to be displayed in the row. This item will be automatically centered.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
},
],
},
"detailsTemplateOverride": { # Override for the details view (beneath the card view).
"detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
{
"item": { # The item to be displayed in the details list.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
],
},
"listTemplateOverride": { # Override for the passes list view.
"firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
"fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"transitOption": "A String",
},
"secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
"enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
"homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
"id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
"linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"localizedCardNumberLabel": { # Translated strings for the card_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedEventNumberLabel": { # Translated strings for the event_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedPinLabel": { # Translated strings for the pin_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
"notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
"programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
"review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
"comments": "A String",
},
"reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
"securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
"animationType": "A String", # Type of animation.
},
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
"viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
"wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
"disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
"eventNumber": "A String", # The card's event number, an optional field used by some gift cards.
"groupingInfo": { # Information that controls how passes are grouped together.
"groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
"sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
},
"hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
"hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`.
"linkedObjectIds": [ # linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
"A String",
],
"linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
"nfcConstraint": [ # The NFC constraints for the pass.
"A String",
],
"screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
"pin": "A String", # The card's PIN.
"rotatingBarcode": { # The rotating barcode type and value.
"alternateText": "A 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.
"initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
"periodMillis": "A String", # Required. The amount of time each barcode is valid for.
"startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
"values": [ # Required. The values to encode in the barcode. At least one value is required.
"A String",
],
},
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
"algorithm": "A String", # The TOTP algorithm used to generate the OTP.
"parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
{ # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
"key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
"valueLength": 42, # The length of the TOTP value in decimal digits.
},
],
"periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
"type": "A String", # The type of this barcode.
"valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
"saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
"restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
},
"smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
"state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"balance": { # The card's monetary balance.
"currencyCode": "A String", # The currency code, such as "USD" or "EUR."
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
"micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
},
"balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"barcode": { # The barcode type and value.
"alternateText": "A 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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"type": "A String", # The type of barcode.
"value": "A String", # The value encoded in the barcode.
},
"cardNumber": "A String", # Required. The card's number.
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
"cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
"classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
"cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
"firstBottomDetail": { # Optional information to display below the barcode.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"cardTemplateOverride": { # Override for the card view.
"cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
"oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
"item": { # The item to be displayed in the row. This item will be automatically centered.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
},
],
},
"detailsTemplateOverride": { # Override for the details view (beneath the card view).
"detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
{
"item": { # The item to be displayed in the details list.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
],
},
"listTemplateOverride": { # Override for the passes list view.
"firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
"fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"transitOption": "A String",
},
"secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
"enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
"homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
"id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
"linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"localizedCardNumberLabel": { # Translated strings for the card_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedEventNumberLabel": { # Translated strings for the event_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedPinLabel": { # Translated strings for the pin_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
"notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
"programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
"review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
"comments": "A String",
},
"reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
"securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
"animationType": "A String", # Type of animation.
},
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
"viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
"wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
"disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
"eventNumber": "A String", # The card's event number, an optional field used by some gift cards.
"groupingInfo": { # Information that controls how passes are grouped together.
"groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
"sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
},
"hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
"hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`.
"linkedObjectIds": [ # linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
"A String",
],
"linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
"nfcConstraint": [ # The NFC constraints for the pass.
"A String",
],
"screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
"pin": "A String", # The card's PIN.
"rotatingBarcode": { # The rotating barcode type and value.
"alternateText": "A 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.
"initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
"periodMillis": "A String", # Required. The amount of time each barcode is valid for.
"startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
"values": [ # Required. The values to encode in the barcode. At least one value is required.
"A String",
],
},
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
"algorithm": "A String", # The TOTP algorithm used to generate the OTP.
"parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
{ # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
"key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
"valueLength": 42, # The length of the TOTP value in decimal digits.
},
],
"periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
"type": "A String", # The type of this barcode.
"valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
"saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
"restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
},
"smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
"state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
}
list(classId=None, maxResults=None, token=None, x__xgafv=None)
Returns a list of all gift card objects for a given issuer ID.
Args:
classId: string, The ID of the class whose objects will be listed.
maxResults: integer, Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token: string, Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"pagination": { # Pagination of the response.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
"nextPageToken": "A String", # Page token to send to fetch the next page.
"resultsPerPage": 42, # Number of results returned in this page.
},
"resources": [ # Resources corresponding to the list request.
{
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"balance": { # The card's monetary balance.
"currencyCode": "A String", # The currency code, such as "USD" or "EUR."
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
"micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
},
"balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"barcode": { # The barcode type and value.
"alternateText": "A 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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"type": "A String", # The type of barcode.
"value": "A String", # The value encoded in the barcode.
},
"cardNumber": "A String", # Required. The card's number.
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
"cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
"classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
"cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
"firstBottomDetail": { # Optional information to display below the barcode.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"cardTemplateOverride": { # Override for the card view.
"cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
"oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
"item": { # The item to be displayed in the row. This item will be automatically centered.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
},
],
},
"detailsTemplateOverride": { # Override for the details view (beneath the card view).
"detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
{
"item": { # The item to be displayed in the details list.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
],
},
"listTemplateOverride": { # Override for the passes list view.
"firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
"fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"transitOption": "A String",
},
"secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
"enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
"homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
"id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
"linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"localizedCardNumberLabel": { # Translated strings for the card_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedEventNumberLabel": { # Translated strings for the event_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedPinLabel": { # Translated strings for the pin_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
"notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
"programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
"review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
"comments": "A String",
},
"reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
"securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
"animationType": "A String", # Type of animation.
},
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
"viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
"wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
"disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
"eventNumber": "A String", # The card's event number, an optional field used by some gift cards.
"groupingInfo": { # Information that controls how passes are grouped together.
"groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
"sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
},
"hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
"hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`.
"linkedObjectIds": [ # linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
"A String",
],
"linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
"nfcConstraint": [ # The NFC constraints for the pass.
"A String",
],
"screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
"pin": "A String", # The card's PIN.
"rotatingBarcode": { # The rotating barcode type and value.
"alternateText": "A 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.
"initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
"periodMillis": "A String", # Required. The amount of time each barcode is valid for.
"startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
"values": [ # Required. The values to encode in the barcode. At least one value is required.
"A String",
],
},
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
"algorithm": "A String", # The TOTP algorithm used to generate the OTP.
"parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
{ # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
"key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
"valueLength": 42, # The length of the TOTP value in decimal digits.
},
],
"periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
"type": "A String", # The type of this barcode.
"valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
"saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
"restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
},
"smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
"state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
},
],
}
patch(resourceId, body=None, x__xgafv=None)
Updates the gift card object referenced by the given object ID. This method supports patch semantics.
Args:
resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
body: object, The request body.
The object takes the form of:
{
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"balance": { # The card's monetary balance.
"currencyCode": "A String", # The currency code, such as "USD" or "EUR."
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
"micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
},
"balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"barcode": { # The barcode type and value.
"alternateText": "A 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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"type": "A String", # The type of barcode.
"value": "A String", # The value encoded in the barcode.
},
"cardNumber": "A String", # Required. The card's number.
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
"cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
"classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
"cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
"firstBottomDetail": { # Optional information to display below the barcode.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"cardTemplateOverride": { # Override for the card view.
"cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
"oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
"item": { # The item to be displayed in the row. This item will be automatically centered.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
},
],
},
"detailsTemplateOverride": { # Override for the details view (beneath the card view).
"detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
{
"item": { # The item to be displayed in the details list.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
],
},
"listTemplateOverride": { # Override for the passes list view.
"firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
"fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"transitOption": "A String",
},
"secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
"enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
"homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
"id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
"linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"localizedCardNumberLabel": { # Translated strings for the card_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedEventNumberLabel": { # Translated strings for the event_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedPinLabel": { # Translated strings for the pin_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
"notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
"programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
"review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
"comments": "A String",
},
"reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
"securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
"animationType": "A String", # Type of animation.
},
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
"viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
"wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
"disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
"eventNumber": "A String", # The card's event number, an optional field used by some gift cards.
"groupingInfo": { # Information that controls how passes are grouped together.
"groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
"sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
},
"hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
"hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`.
"linkedObjectIds": [ # linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
"A String",
],
"linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
"nfcConstraint": [ # The NFC constraints for the pass.
"A String",
],
"screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
"pin": "A String", # The card's PIN.
"rotatingBarcode": { # The rotating barcode type and value.
"alternateText": "A 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.
"initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
"periodMillis": "A String", # Required. The amount of time each barcode is valid for.
"startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
"values": [ # Required. The values to encode in the barcode. At least one value is required.
"A String",
],
},
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
"algorithm": "A String", # The TOTP algorithm used to generate the OTP.
"parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
{ # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
"key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
"valueLength": 42, # The length of the TOTP value in decimal digits.
},
],
"periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
"type": "A String", # The type of this barcode.
"valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
"saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
"restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
},
"smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
"state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"balance": { # The card's monetary balance.
"currencyCode": "A String", # The currency code, such as "USD" or "EUR."
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
"micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
},
"balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"barcode": { # The barcode type and value.
"alternateText": "A 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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"type": "A String", # The type of barcode.
"value": "A String", # The value encoded in the barcode.
},
"cardNumber": "A String", # Required. The card's number.
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
"cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
"classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
"cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
"firstBottomDetail": { # Optional information to display below the barcode.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"cardTemplateOverride": { # Override for the card view.
"cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
"oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
"item": { # The item to be displayed in the row. This item will be automatically centered.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
},
],
},
"detailsTemplateOverride": { # Override for the details view (beneath the card view).
"detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
{
"item": { # The item to be displayed in the details list.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
],
},
"listTemplateOverride": { # Override for the passes list view.
"firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
"fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"transitOption": "A String",
},
"secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
"enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
"homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
"id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
"linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"localizedCardNumberLabel": { # Translated strings for the card_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedEventNumberLabel": { # Translated strings for the event_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedPinLabel": { # Translated strings for the pin_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
"notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
"programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
"review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
"comments": "A String",
},
"reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
"securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
"animationType": "A String", # Type of animation.
},
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
"viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
"wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
"disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
"eventNumber": "A String", # The card's event number, an optional field used by some gift cards.
"groupingInfo": { # Information that controls how passes are grouped together.
"groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
"sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
},
"hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
"hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`.
"linkedObjectIds": [ # linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
"A String",
],
"linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
"nfcConstraint": [ # The NFC constraints for the pass.
"A String",
],
"screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
"pin": "A String", # The card's PIN.
"rotatingBarcode": { # The rotating barcode type and value.
"alternateText": "A 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.
"initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
"periodMillis": "A String", # Required. The amount of time each barcode is valid for.
"startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
"values": [ # Required. The values to encode in the barcode. At least one value is required.
"A String",
],
},
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
"algorithm": "A String", # The TOTP algorithm used to generate the OTP.
"parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
{ # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
"key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
"valueLength": 42, # The length of the TOTP value in decimal digits.
},
],
"periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
"type": "A String", # The type of this barcode.
"valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
"saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
"restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
},
"smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
"state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
}
update(resourceId, body=None, x__xgafv=None)
Updates the gift card object referenced by the given object ID.
Args:
resourceId: string, The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. (required)
body: object, The request body.
The object takes the form of:
{
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"balance": { # The card's monetary balance.
"currencyCode": "A String", # The currency code, such as "USD" or "EUR."
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
"micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
},
"balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"barcode": { # The barcode type and value.
"alternateText": "A 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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"type": "A String", # The type of barcode.
"value": "A String", # The value encoded in the barcode.
},
"cardNumber": "A String", # Required. The card's number.
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
"cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
"classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
"cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
"firstBottomDetail": { # Optional information to display below the barcode.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"cardTemplateOverride": { # Override for the card view.
"cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
"oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
"item": { # The item to be displayed in the row. This item will be automatically centered.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
},
],
},
"detailsTemplateOverride": { # Override for the details view (beneath the card view).
"detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
{
"item": { # The item to be displayed in the details list.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
],
},
"listTemplateOverride": { # Override for the passes list view.
"firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
"fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"transitOption": "A String",
},
"secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
"enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
"homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
"id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
"linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"localizedCardNumberLabel": { # Translated strings for the card_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedEventNumberLabel": { # Translated strings for the event_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedPinLabel": { # Translated strings for the pin_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
"notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
"programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
"review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
"comments": "A String",
},
"reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
"securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
"animationType": "A String", # Type of animation.
},
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
"viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
"wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
"disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
"eventNumber": "A String", # The card's event number, an optional field used by some gift cards.
"groupingInfo": { # Information that controls how passes are grouped together.
"groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
"sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
},
"hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
"hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`.
"linkedObjectIds": [ # linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
"A String",
],
"linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
"nfcConstraint": [ # The NFC constraints for the pass.
"A String",
],
"screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
"pin": "A String", # The card's PIN.
"rotatingBarcode": { # The rotating barcode type and value.
"alternateText": "A 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.
"initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
"periodMillis": "A String", # Required. The amount of time each barcode is valid for.
"startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
"values": [ # Required. The values to encode in the barcode. At least one value is required.
"A String",
],
},
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
"algorithm": "A String", # The TOTP algorithm used to generate the OTP.
"parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
{ # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
"key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
"valueLength": 42, # The length of the TOTP value in decimal digits.
},
],
"periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
"type": "A String", # The type of this barcode.
"valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
"saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
"restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
},
"smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
"state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"balance": { # The card's monetary balance.
"currencyCode": "A String", # The currency code, such as "USD" or "EUR."
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
"micros": "A String", # The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
},
"balanceUpdateTime": { # The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"barcode": { # The barcode type and value.
"alternateText": "A 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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"type": "A String", # The type of barcode.
"value": "A String", # The value encoded in the barcode.
},
"cardNumber": "A String", # Required. The card's number.
"classId": "A String", # Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
"classReference": { # A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
"allowBarcodeRedemption": True or False, # Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
"allowMultipleUsersPerObject": True or False, # Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
"appLinkData": { # Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
"androidAppLinkInfo": { # Optional information about the partner app link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"iosAppLinkInfo": { # Deprecated. Links to open iOS apps are not supported.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
"webAppLinkInfo": { # Optional information about the partner web link.
"appLogoImage": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated. Image isn't supported in the app link module.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"appTarget": { # Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
"packageName": "A String", # Package name for AppTarget. For example: com.google.android.gm
"targetUri": { # URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
},
"description": { # Deprecated. Description isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"title": { # Deprecated. Title isn't supported in the app link module.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
},
"callbackOptions": { # Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
"updateRequestUrl": "A String", # URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
"url": "A String", # The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
},
"cardNumberLabel": "A String", # The label to display for the card number, such as "Card Number".
"classTemplateInfo": { # Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
"cardBarcodeSectionDetails": { # Specifies extra information to be displayed above and below the barcode.
"firstBottomDetail": { # Optional information to display below the barcode.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"firstTopDetail": { # Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"secondTopDetail": { # Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
"fieldSelector": { # Custom field selector to use with field overrides. # A reference to an existing text-based or image field to display.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"cardTemplateOverride": { # Override for the card view.
"cardRowTemplateInfos": [ # Template information for rows in the card view. At most three rows are allowed to be specified.
{
"oneItem": { # Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
"item": { # The item to be displayed in the row. This item will be automatically centered.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"threeItems": { # Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"middleItem": { # The item to be displayed in the middle of the row. This item will be centered between the start and end items.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"twoItems": { # Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
"endItem": { # The item to be displayed at the end of the row. This item will be aligned to the right.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
"startItem": { # The item to be displayed at the start of the row. This item will be aligned to the left.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
},
],
},
"detailsTemplateOverride": { # Override for the details view (beneath the card view).
"detailsItemInfos": [ # Information for the "nth" item displayed in the details list.
{
"item": { # The item to be displayed in the details list.
"firstValue": { # Custom field selector to use with field overrides. # A reference to a field to display. If both `firstValue` and `secondValue` are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"predefinedItem": "A String", # A predefined item to display. Only one of `firstValue` or `predefinedItem` may be set.
"secondValue": { # Custom field selector to use with field overrides. # A reference to a field to display. This may only be populated if the `firstValue` field is populated.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
],
},
"listTemplateOverride": { # Override for the passes list view.
"firstRowOption": { # Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
"fieldOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the first row.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"transitOption": "A String",
},
"secondRowOption": { # Custom field selector to use with field overrides. # A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
"thirdRowOption": { # Custom field selector to use with field overrides. # An unused/deprecated field. Setting it will have no effect on what the user sees.
"fields": [ # If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
{ # Reference definition to use with field overrides.
"dateFormat": "A String", # Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.
"fieldPath": "A String", # Path to the field being referenced, prefixed with "object" or "class" and separated with dots. For example, it may be the string "object.purchaseDetails.purchasePrice".
},
],
},
},
},
"countryCode": "A String", # Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
"enableSmartTap": True or False, # Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"eventNumberLabel": "A String", # The label to display for event number, such as "Target Event #".
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"hexBackgroundColor": "A String", # The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
"homepageUri": { # The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
"id": "A String", # Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`.
"linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"localizedCardNumberLabel": { # Translated strings for the card_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedEventNumberLabel": { # Translated strings for the event_number_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedMerchantName": { # Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedPinLabel": { # Translated strings for the pin_label.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"merchantName": "A String", # Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class.
"notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN".
"programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
"A String",
],
"review": { # The review comments set by the platform when a class is marked `approved` or `rejected`.
"comments": "A String",
},
"reviewStatus": "A String", # Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
"securityAnimation": { # Optional information about the security animation. If this is set a security animation will be rendered on pass details.
"animationType": "A String", # Type of animation.
},
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
"viewUnlockRequirement": "A String", # View Unlock Requirement options for the gift card.
"wideProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"wordMark": { # Wrapping type for Google hosted images. Next ID: 7 # Deprecated.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
"disableExpirationNotification": True or False, # Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
"eventNumber": "A String", # The card's event number, an optional field used by some gift cards.
"groupingInfo": { # Information that controls how passes are grouped together.
"groupingId": "A String", # Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
"sortIndex": 42, # Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.
},
"hasLinkedDevice": True or False, # Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
"hasUsers": True or False, # Indicates if the object has users. This field is set by the platform.
"heroImage": { # Wrapping type for Google hosted images. Next ID: 7 # Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"id": "A String", # Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
"imageModulesData": [ # Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
{
"id": "A String", # The ID associated with an image module. This field is here to enable ease of management of image modules.
"mainImage": { # Wrapping type for Google hosted images. Next ID: 7 # A 100% width image.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
},
],
"infoModuleData": { # Deprecated. Use textModulesData instead.
"labelValueRows": [ # A list of collections of labels and values. These will be displayed one after the other in a singular column.
{
"columns": [ # A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.
{ # A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
"label": "A String", # The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"localizedLabel": { # Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedValue": { # Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"value": "A String", # The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
},
],
},
],
"showLastUpdateTime": True or False,
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`.
"linkedObjectIds": [ # linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
"A String",
],
"linksModuleData": { # Links module data. If links module data is also defined on the class, both will be displayed.
"uris": [ # The list of URIs.
{
"description": "A String", # The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
"id": "A String", # The ID associated with a uri. This field is here to enable ease of management of uris.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
"localizedDescription": { # Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of a web page, image, or other resource. URIs in the `LinksModuleData` module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.
},
],
},
"locations": [ # Note: This field is currently not supported to trigger geo notifications.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
"latitude": 3.14, # The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
"longitude": 3.14, # The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
},
],
"messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
{ # A message that will be displayed with a Valuable
"body": "A String", # The message body.
"displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"header": "A String", # The message header.
"id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
"localizedBody": { # Translated strings for the message body.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the message header.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"messageType": "A String", # The message type.
},
],
"notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
"passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
"nfcConstraint": [ # The NFC constraints for the pass.
"A String",
],
"screenshotEligibility": "A String", # The screenshot eligibility for the pass.
},
"pin": "A String", # The card's PIN.
"rotatingBarcode": { # The rotating barcode type and value.
"alternateText": "A 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.
"initialRotatingBarcodeValues": { # A payload containing many barcode values and start date/time. # Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
"periodMillis": "A String", # Required. The amount of time each barcode is valid for.
"startDateTime": "A String", # Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.
"values": [ # Required. The values to encode in the barcode. At least one value is required.
"A String",
],
},
"renderEncoding": "A String", # The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
"showCodeText": { # 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.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"totpDetails": { # Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238 # Details used to evaluate the {totp_value_n} substitutions.
"algorithm": "A String", # The TOTP algorithm used to generate the OTP.
"parameters": [ # The TOTP parameters for each of the {totp_value_*} substitutions. The TotpParameters at index n is used for the {totp_value_n} substitution.
{ # Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3
"key": "A String", # The secret key used for the TOTP value generation, encoded as a Base16 string.
"valueLength": 42, # The length of the TOTP value in decimal digits.
},
],
"periodMillis": "A String", # The time interval used for the TOTP value generation, in milliseconds.
},
"type": "A String", # The type of this barcode.
"valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.
},
"saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
"restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
},
"smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
"state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
"textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
{ # Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
"body": "A String", # The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"header": "A String", # The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"id": "A String", # The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
"localizedBody": { # Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"localizedHeader": { # Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
},
],
"validTimeInterval": { # The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
"valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"header": { # Header to be displayed on the module. Character limit is 60 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"image": { # Wrapping type for Google hosted images. Next ID: 7 # Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio.
"contentDescription": { # Description of the image used for accessibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
"sourceUri": { # The URI for the image.
"description": "A String", # Additional information about the image, which is unused and retained only for backward compatibility.
"localizedDescription": { # Translated strings for the description, which are unused and retained only for backward compatibility.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
"translatedValues": [ # Contains the translations for the string.
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
"language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
"value": "A String", # The UTF-8 encoded translated string.
},
],
},
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
"sortIndex": 42, # The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.
"uri": "A String", # URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.
"viewConstraints": { # Constraints that all must be met for the module to be shown. # Constraints that all must be met for the module to be shown.
"displayInterval": { # The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set.
"end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
"start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset.
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
},
},
],
"version": "A String", # Deprecated
}