Updates the transit object referenced by the given object ID. This method supports patch semantics.
Scopes
You will need authorization for the https://www.googleapis.com/auth/wallet_object.issuer scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/wallet_object.issuer.
You can set the scope for this method like this: walletobjects1 --scope <scope> transitobject patch ...
Required Scalar Argument
- <resource-id> (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 Request Value
The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.
For example, a structure like this:
TransitObject:
activation-status:
state: string
app-link-data:
android-app-link-info:
app-logo-image:
content-description:
default-value:
kind: string
language: string
value: string
kind: string
kind: string
source-uri:
description: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
app-target:
package-name: string
target-uri:
description: string
id: string
kind: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
description:
default-value:
kind: string
language: string
value: string
kind: string
title:
default-value:
kind: string
language: string
value: string
kind: string
ios-app-link-info:
app-logo-image:
content-description:
default-value:
kind: string
language: string
value: string
kind: string
kind: string
source-uri:
description: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
app-target:
package-name: string
target-uri:
description: string
id: string
kind: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
description:
default-value:
kind: string
language: string
value: string
kind: string
title:
default-value:
kind: string
language: string
value: string
kind: string
web-app-link-info:
app-logo-image:
content-description:
default-value:
kind: string
language: string
value: string
kind: string
kind: string
source-uri:
description: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
app-target:
package-name: string
target-uri:
description: string
id: string
kind: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
description:
default-value:
kind: string
language: string
value: string
kind: string
title:
default-value:
kind: string
language: string
value: string
kind: string
barcode:
alternate-text: string
kind: string
render-encoding: string
show-code-text:
default-value:
kind: string
language: string
value: string
kind: string
type: string
value: string
class-id: string
class-reference:
activation-options:
activation-url: string
allow-reactivation: boolean
allow-multiple-users-per-object: boolean
callback-options:
update-request-url: string
url: string
class-template-info:
list-template-override:
first-row-option:
transit-option: string
country-code: string
custom-carriage-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-coach-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-concession-category-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-confirmation-code-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-discount-message-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-fare-class-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-fare-name-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-other-restrictions-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-platform-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-purchase-face-value-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-purchase-price-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-purchase-receipt-number-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-route-restrictions-details-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-route-restrictions-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-seat-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-ticket-number-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-time-restrictions-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-transit-terminus-name-label:
default-value:
kind: string
language: string
value: string
kind: string
custom-zone-label:
default-value:
kind: string
language: string
value: string
kind: string
enable-single-leg-itinerary: boolean
enable-smart-tap: boolean
hero-image:
content-description:
default-value:
kind: string
language: string
value: string
kind: string
kind: string
source-uri:
description: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
hex-background-color: string
homepage-uri:
description: string
id: string
kind: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
id: string
info-module-data:
show-last-update-time: boolean
issuer-name: string
language-override: string
localized-issuer-name:
default-value:
kind: string
language: string
value: string
kind: string
logo:
content-description:
default-value:
kind: string
language: string
value: string
kind: string
kind: string
source-uri:
description: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
multiple-devices-and-holders-allowed-status: string
redemption-issuers: [string]
review:
comments: string
review-status: string
security-animation:
animation-type: string
transit-operator-name:
default-value:
kind: string
language: string
value: string
kind: string
transit-type: string
version: string
view-unlock-requirement: string
watermark:
content-description:
default-value:
kind: string
language: string
value: string
kind: string
kind: string
source-uri:
description: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
wide-logo:
content-description:
default-value:
kind: string
language: string
value: string
kind: string
kind: string
source-uri:
description: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
word-mark:
content-description:
default-value:
kind: string
language: string
value: string
kind: string
kind: string
source-uri:
description: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
concession-category: string
custom-concession-category:
default-value:
kind: string
language: string
value: string
kind: string
custom-ticket-status:
default-value:
kind: string
language: string
value: string
kind: string
device-context:
device-token: string
disable-expiration-notification: boolean
grouping-info:
grouping-id: string
sort-index: integer
has-linked-device: boolean
has-users: boolean
hero-image:
content-description:
default-value:
kind: string
language: string
value: string
kind: string
kind: string
source-uri:
description: string
localized-description:
default-value:
kind: string
language: string
value: string
kind: string
uri: string
hex-background-color: string
id: string
info-module-data:
show-last-update-time: boolean
pass-constraints:
nfc-constraint: [string]
screenshot-eligibility: string
passenger-names: string
passenger-type: string
purchase-details:
account-id: string
confirmation-code: string
purchase-date-time: string
purchase-receipt-number: string
ticket-cost:
discount-message:
default-value:
kind: string
language: string
value: string
kind: string
face-value:
currency-code: string
kind: string
micros: string
purchase-price:
currency-code: string
kind: string
micros: string
rotating-barcode:
alternate-text: string
initial-rotating-barcode-values:
period-millis: string
start-date-time: string
values: [string]
render-encoding: string
show-code-text:
default-value:
kind: string
language: string
value: string
kind: string
totp-details:
algorithm: string
period-millis: string
type: string
value-pattern: string
smart-tap-redemption-value: string
state: string
ticket-leg:
arrival-date-time: string
carriage: string
departure-date-time: string
destination-name:
default-value:
kind: string
language: string
value: string
kind: string
destination-station-code: string
fare-name:
default-value:
kind: string
language: string
value: string
kind: string
origin-name:
default-value:
kind: string
language: string
value: string
kind: string
origin-station-code: string
platform: string
ticket-seat:
coach: string
custom-fare-class:
default-value:
kind: string
language: string
value: string
kind: string
fare-class: string
seat: string
seat-assignment:
default-value:
kind: string
language: string
value: string
kind: string
transit-operator-name:
default-value:
kind: string
language: string
value: string
kind: string
transit-terminus-name:
default-value:
kind: string
language: string
value: string
kind: string
zone: string
ticket-number: string
ticket-restrictions:
other-restrictions:
default-value:
kind: string
language: string
value: string
kind: string
route-restrictions:
default-value:
kind: string
language: string
value: string
kind: string
route-restrictions-details:
default-value:
kind: string
language: string
value: string
kind: string
time-restrictions:
default-value:
kind: string
language: string
value: string
kind: string
ticket-status: string
trip-id: string
trip-type: string
valid-time-interval:
end:
date: string
kind: string
start:
date: string
version: string
can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.
-
-r .activation-status state=sea
- No description provided.
-
..app-link-data.android-app-link-info.app-logo-image.content-description.default-value kind=diam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=amet
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=et
- The UTF-8 encoded translated string.
-
.. kind=dolor
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. kind=sadipscing
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#image"
.
- Identifies what kind of resource this is. Value: the fixed string
source-uri description=stet
- Additional information about the image, which is unused and retained only for backward compatibility.
localized-description.default-value kind=duo
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=ea
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=at
- The UTF-8 encoded translated string.
-
.. kind=elitr
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=clita
- The location of the image. URIs must have a scheme.
-
...app-target package-name=erat
- Package name for AppTarget. For example: com.google.android.gm
target-uri description=est
- 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.
- 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
id=sea
- The ID associated with a uri. This field is here to enable ease of management of uris.
kind=invidunt
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#uri"
.
- Identifies what kind of resource this is. Value: the fixed string
localized-description.default-value kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=labore
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=voluptua.
- The UTF-8 encoded translated string.
-
.. kind=accusam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=ea
- 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.
- The location of a web page, image, or other resource. URIs in the
-
...description.default-value kind=aliquyam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=nonumy
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=dolore
- The UTF-8 encoded translated string.
-
.. kind=clita
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..title.default-value kind=ipsum
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sed
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=et
- The UTF-8 encoded translated string.
-
.. kind=invidunt
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
...ios-app-link-info.app-logo-image.content-description.default-value kind=eos
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sit
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=duo
- The UTF-8 encoded translated string.
-
.. kind=ut
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. kind=accusam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#image"
.
- Identifies what kind of resource this is. Value: the fixed string
source-uri description=dolore
- Additional information about the image, which is unused and retained only for backward compatibility.
localized-description.default-value kind=accusam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=dolore
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=erat
- The UTF-8 encoded translated string.
-
.. kind=amet.
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=sadipscing
- The location of the image. URIs must have a scheme.
-
...app-target package-name=et
- Package name for AppTarget. For example: com.google.android.gm
target-uri description=gubergren
- 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.
- 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
id=sit
- The ID associated with a uri. This field is here to enable ease of management of uris.
kind=ut
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#uri"
.
- Identifies what kind of resource this is. Value: the fixed string
localized-description.default-value kind=amet.
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sit
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=et
- The UTF-8 encoded translated string.
-
.. kind=diam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=et
- 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.
- The location of a web page, image, or other resource. URIs in the
-
...description.default-value kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=eirmod
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=dolores
- The UTF-8 encoded translated string.
-
.. kind=voluptua.
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..title.default-value kind=labore
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=eirmod
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=diam
- The UTF-8 encoded translated string.
-
.. kind=ipsum
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
...web-app-link-info.app-logo-image.content-description.default-value kind=dolor
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=et
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=dolore
- The UTF-8 encoded translated string.
-
.. kind=ipsum
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. kind=accusam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#image"
.
- Identifies what kind of resource this is. Value: the fixed string
source-uri description=et
- Additional information about the image, which is unused and retained only for backward compatibility.
localized-description.default-value kind=lorem
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=ipsum
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=rebum.
- The UTF-8 encoded translated string.
-
.. kind=diam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=nonumy
- The location of the image. URIs must have a scheme.
-
...app-target package-name=tempor
- Package name for AppTarget. For example: com.google.android.gm
target-uri description=takimata
- 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.
- 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
id=dolores
- The ID associated with a uri. This field is here to enable ease of management of uris.
kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#uri"
.
- Identifies what kind of resource this is. Value: the fixed string
localized-description.default-value kind=stet
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=clita
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=tempor
- The UTF-8 encoded translated string.
-
.. kind=ut
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=nonumy
- 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.
- The location of a web page, image, or other resource. URIs in the
-
...description.default-value kind=ipsum
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=at
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=sit
- The UTF-8 encoded translated string.
-
.. kind=accusam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..title.default-value kind=labore
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=eirmod
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=et
- The UTF-8 encoded translated string.
-
.. kind=ea
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
....barcode alternate-text=vero
- 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=clita
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#barcode"
.
- Identifies what kind of resource this is. Value: the fixed string
render-encoding=rebum.
- The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
show-code-text.default-value kind=gubergren
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=dolores
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=sed
- The UTF-8 encoded translated string.
-
.. kind=clita
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. type=diam
- The type of barcode.
-
value=vero
- The value encoded in the barcode.
-
.. class-id=justo
- 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.
class-reference.activation-options activation-url=et
- HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
-
allow-reactivation=true
- Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
-
.. allow-multiple-users-per-object=true
- Deprecated. Use
multipleDevicesAndHoldersAllowedStatus
instead.
- Deprecated. Use
callback-options update-request-url=et
- 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:Google-Valuables. Deprecated.
-
url=sed
- 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:Google-Valuables.
-
..class-template-info.list-template-override.first-row-option transit-option=dolor
- No description provided.
-
.... country-code=no
- 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.
custom-carriage-label.default-value kind=diam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=amet.
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=dolores
- The UTF-8 encoded translated string.
-
.. kind=erat
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-coach-label.default-value kind=sanctus
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=est
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=at
- The UTF-8 encoded translated string.
-
.. kind=diam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-concession-category-label.default-value kind=at
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=clita
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=lorem
- The UTF-8 encoded translated string.
-
.. kind=elitr
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-confirmation-code-label.default-value kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=at
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=magna
- The UTF-8 encoded translated string.
-
.. kind=tempor
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-discount-message-label.default-value kind=sanctus
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=ipsum
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=sea
- The UTF-8 encoded translated string.
-
.. kind=diam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-fare-class-label.default-value kind=lorem
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=aliquyam
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=tempor
- The UTF-8 encoded translated string.
-
.. kind=lorem
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-fare-name-label.default-value kind=sed
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=justo
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=kasd
- The UTF-8 encoded translated string.
-
.. kind=stet
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-other-restrictions-label.default-value kind=dolore
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=est
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=dolores
- The UTF-8 encoded translated string.
-
.. kind=diam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-platform-label.default-value kind=dolor
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sadipscing
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=labore
- The UTF-8 encoded translated string.
-
.. kind=sed
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-purchase-face-value-label.default-value kind=amet
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=et
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=erat
- The UTF-8 encoded translated string.
-
.. kind=sea
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-purchase-price-label.default-value kind=kasd
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sed
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=accusam
- The UTF-8 encoded translated string.
-
.. kind=justo
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-purchase-receipt-number-label.default-value kind=dolor
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=aliquyam
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=accusam
- The UTF-8 encoded translated string.
-
.. kind=vero
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-route-restrictions-details-label.default-value kind=ipsum
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=dolore
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=voluptua.
- The UTF-8 encoded translated string.
-
.. kind=invidunt
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-route-restrictions-label.default-value kind=tempor
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=no
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=dolor
- The UTF-8 encoded translated string.
-
.. kind=est
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-seat-label.default-value kind=magna
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=lorem
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=sit
- The UTF-8 encoded translated string.
-
.. kind=dolor
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-ticket-number-label.default-value kind=tempor
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sed
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=accusam
- The UTF-8 encoded translated string.
-
.. kind=dolore
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-time-restrictions-label.default-value kind=lorem
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=lorem
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=ipsum
- The UTF-8 encoded translated string.
-
.. kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-transit-terminus-name-label.default-value kind=sit
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=vero
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=sea
- The UTF-8 encoded translated string.
-
.. kind=eos
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-zone-label.default-value kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sea
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=amet
- The UTF-8 encoded translated string.
-
.. kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. enable-single-leg-itinerary=true
- Controls the display of the single-leg itinerary for this class. By default, an itinerary will only display for multi-leg trips.
enable-smart-tap=false
- Identifies whether this class supports Smart Tap. The
redemptionIssuers
and object levelsmartTapRedemptionLevel
fields must also be set up correctly in order for a pass to support Smart Tap.
- Identifies whether this class supports Smart Tap. The
hero-image.content-description.default-value kind=duo
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=labore
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=sit
- The UTF-8 encoded translated string.
-
.. kind=lorem
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. kind=lorem
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#image"
.
- Identifies what kind of resource this is. Value: the fixed string
source-uri description=sit
- Additional information about the image, which is unused and retained only for backward compatibility.
localized-description.default-value kind=duo
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=stet
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=rebum.
- The UTF-8 encoded translated string.
-
.. kind=erat
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=amet.
- The location of the image. URIs must have a scheme.
-
... hex-background-color=stet
- 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
.
- 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
homepage-uri description=eos
- 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.
- 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
id=dolor
- The ID associated with a uri. This field is here to enable ease of management of uris.
kind=dolor
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#uri"
.
- Identifies what kind of resource this is. Value: the fixed string
localized-description.default-value kind=clita
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sea
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=at
- The UTF-8 encoded translated string.
-
.. kind=ea
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=clita
- 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.
- The location of a web page, image, or other resource. URIs in the
-
.. id=sadipscing
- 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 '-'.
-
info-module-data show-last-update-time=true
- No description provided.
-
.. issuer-name=est
- Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
language-override=diam
- If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
localized-issuer-name.default-value kind=eos
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=diam
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=ea
- The UTF-8 encoded translated string.
-
.. kind=labore
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..logo.content-description.default-value kind=ipsum
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=ut
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=diam
- The UTF-8 encoded translated string.
-
.. kind=at
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. kind=ut
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#image"
.
- Identifies what kind of resource this is. Value: the fixed string
source-uri description=ipsum
- Additional information about the image, which is unused and retained only for backward compatibility.
localized-description.default-value kind=kasd
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=takimata
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=stet
- The UTF-8 encoded translated string.
-
.. kind=est
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=sit
- The location of the image. URIs must have a scheme.
-
... multiple-devices-and-holders-allowed-status=dolore
- Identifies whether multiple users and devices will save the same object referencing this class.
redemption-issuers=vero
- 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 levelsmartTapRedemptionLevel
fields must also be set up correctly in order for a pass to support Smart Tap. - Each invocation of this argument appends the given value to the array.
- 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
-
review comments=tempor
- No description provided.
-
.. review-status=aliquyam
- Required. The status of the class. This field can be set to
draft
orunderReview
using the insert, patch, or update API calls. Once the review state is changed fromdraft
it may not be changed back todraft
. You should keep this field todraft
when the class is under development. Adraft
class cannot be used to create any object. You should set this field tounderReview
when you believe the class is ready for use. The platform will automatically set this field toapproved
and it can be immediately used to create or migrate objects. When updating an alreadyapproved
class you should keep setting this field tounderReview
.
- Required. The status of the class. This field can be set to
-
security-animation animation-type=dolor
- Type of animation.
-
..transit-operator-name.default-value kind=accusam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=dolor
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=lorem
- The UTF-8 encoded translated string.
-
.. kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. transit-type=kasd
- Required. The type of transit this class represents, such as "bus".
version=lorem
- Deprecated
view-unlock-requirement=ea
- View Unlock Requirement options for the transit ticket.
watermark.content-description.default-value kind=invidunt
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=eos
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=aliquyam
- The UTF-8 encoded translated string.
-
.. kind=no
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. kind=eos
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#image"
.
- Identifies what kind of resource this is. Value: the fixed string
source-uri description=dolor
- Additional information about the image, which is unused and retained only for backward compatibility.
localized-description.default-value kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=ipsum
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=amet.
- The UTF-8 encoded translated string.
-
.. kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=justo
- The location of the image. URIs must have a scheme.
-
...wide-logo.content-description.default-value kind=consetetur
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sadipscing
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=et
- The UTF-8 encoded translated string.
-
.. kind=sadipscing
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#image"
.
- Identifies what kind of resource this is. Value: the fixed string
source-uri description=diam
- Additional information about the image, which is unused and retained only for backward compatibility.
localized-description.default-value kind=accusam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sed
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=duo
- The UTF-8 encoded translated string.
-
.. kind=aliquyam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=accusam
- The location of the image. URIs must have a scheme.
-
...word-mark.content-description.default-value kind=ipsum
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=voluptua.
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=nonumy
- The UTF-8 encoded translated string.
-
.. kind=eirmod
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. kind=diam
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#image"
.
- Identifies what kind of resource this is. Value: the fixed string
source-uri description=sed
- Additional information about the image, which is unused and retained only for backward compatibility.
localized-description.default-value kind=sit
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=labore
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=et
- The UTF-8 encoded translated string.
-
.. kind=erat
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=aliquyam
- The location of the image. URIs must have a scheme.
-
.... concession-category=diam
- The concession category for the ticket.
custom-concession-category.default-value kind=voluptua.
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=stet
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=eos
- The UTF-8 encoded translated string.
-
.. kind=kasd
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..custom-ticket-status.default-value kind=duo
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=duo
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=tempor
- The UTF-8 encoded translated string.
-
.. kind=tempor
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..device-context device-token=elitr
- If set, redemption information will only be returned to the given device upon activation of the object. This should not be used as a stable identifier to trace a user's device. It can change across different passes for the same device or even across different activations for the same device. When setting this, callers must also set has_linked_device on the object being activated.
-
.. disable-expiration-notification=true
- 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.
- Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the
grouping-info grouping-id=lorem
- Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
-
sort-index=57
- 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.
-
.. has-linked-device=true
- 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.
has-users=false
- Indicates if the object has users. This field is set by the platform.
hero-image.content-description.default-value kind=ipsum
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=diam
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=amet.
- The UTF-8 encoded translated string.
-
.. kind=justo
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. kind=amet.
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#image"
.
- Identifies what kind of resource this is. Value: the fixed string
source-uri description=consetetur
- Additional information about the image, which is unused and retained only for backward compatibility.
localized-description.default-value kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=dolore
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=no
- The UTF-8 encoded translated string.
-
.. kind=lorem
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. uri=no
- The location of the image. URIs must have a scheme.
-
... hex-background-color=diam
- 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
.
- 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
id=sed
- 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 '-'.
-
info-module-data show-last-update-time=false
- No description provided.
-
..pass-constraints nfc-constraint=at
- The NFC constraints for the pass.
- Each invocation of this argument appends the given value to the array.
-
screenshot-eligibility=vero
- The screenshot eligibility for the pass.
-
.. passenger-names=gubergren
- The name(s) of the passengers the ticket is assigned to. The above
passengerType
field is meant to give Google context on this field.
- The name(s) of the passengers the ticket is assigned to. The above
passenger-type=magna
- The number of passengers.
purchase-details account-id=dolor
- ID of the account used to purchase the ticket.
confirmation-code=sit
- The confirmation code for the purchase. This may be the same for multiple different tickets and is used to group tickets together.
purchase-date-time=ipsum
- The purchase date/time of the ticket. This is an ISO 8601 extended format date/time, with or without 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.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. Without offset information, some rich features may not be available.
- The purchase date/time of the ticket. This is an ISO 8601 extended format date/time, with or without 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:
purchase-receipt-number=dolor
- Receipt number/identifier for tracking the ticket purchase via the body that sold the ticket.
ticket-cost.discount-message.default-value kind=nonumy
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=invidunt
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=sit
- The UTF-8 encoded translated string.
-
.. kind=ea
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..face-value currency-code=ea
- The currency code, such as "USD" or "EUR."
kind=justo
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#money"
.
- Identifies what kind of resource this is. Value: the fixed string
-
micros=stet
- The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
-
..purchase-price currency-code=sed
- The currency code, such as "USD" or "EUR."
kind=clita
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#money"
.
- Identifies what kind of resource this is. Value: the fixed string
-
micros=aliquyam
- The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
-
....rotating-barcode alternate-text=accusam
- 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.
initial-rotating-barcode-values period-millis=erat
- Required. The amount of time each barcode is valid for.
start-date-time=justo
- 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.
- 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:
-
values=eirmod
- Required. The values to encode in the barcode. At least one value is required.
- Each invocation of this argument appends the given value to the array.
-
.. render-encoding=tempor
- The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
show-code-text.default-value kind=sea
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=aliquyam
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=dolor
- The UTF-8 encoded translated string.
-
.. kind=est
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..totp-details algorithm=nonumy
- The TOTP algorithm used to generate the OTP.
-
period-millis=eirmod
- The time interval used for the TOTP value generation, in milliseconds.
-
.. type=nonumy
- The type of this barcode.
-
value-pattern=accusam
- 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.
-
.. smart-tap-redemption-value=elitr
- The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields
enableSmartTap
andredemptionIssuers
must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
- The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields
state=dolor
- 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.
- Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an
ticket-leg arrival-date-time=tempor
- The date/time of arrival. This is an ISO 8601 extended format date/time, with or without 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.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. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the destination station. For example, if the event occurs at the 20th hour of June 5th, 2018 at the destination station, the local date/time portion should be2018-06-05T20:00:00
. If the local date/time at the destination station is 4 hours before UTC, an offset of-04:00
may be appended. Without offset information, some rich features may not be available.
- The date/time of arrival. This is an ISO 8601 extended format date/time, with or without 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:
carriage=labore
- The train or ship name/number that the passsenger needs to board.
departure-date-time=justo
- The date/time of departure. This is required if there is no validity time interval set on the transit object. This is an ISO 8601 extended format date/time, with or without 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.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. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the origin station. For example, if the departure occurs at the 20th hour of June 5th, 2018 at the origin station, the local date/time portion should be2018-06-05T20:00:00
. If the local date/time at the origin station is 4 hours before UTC, an offset of-04:00
may be appended. Without offset information, some rich features may not be available.
- The date/time of departure. This is required if there is no validity time interval set on the transit object. This is an ISO 8601 extended format date/time, with or without 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:
destination-name.default-value kind=clita
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=ipsum
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=lorem
- The UTF-8 encoded translated string.
-
.. kind=at
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. destination-station-code=nonumy
- The destination station code.
fare-name.default-value kind=sit
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sit
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=stet
- The UTF-8 encoded translated string.
-
.. kind=consetetur
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..origin-name.default-value kind=rebum.
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=amet
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=et
- The UTF-8 encoded translated string.
-
.. kind=eirmod
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. origin-station-code=dolore
- The origin station code. This is required if
destinationStationCode
is present or iforiginName
is not present.
- The origin station code. This is required if
platform=sadipscing
- The platform or gate where the passenger can board the carriage.
ticket-seat coach=nonumy
- The identifier of the train car or coach in which the ticketed seat is located. Eg. "10"
custom-fare-class.default-value kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sea
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=accusam
- The UTF-8 encoded translated string.
-
.. kind=no
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. fare-class=et
- The fare class of the ticketed seat.
seat=ipsum
- The identifier of where the ticketed seat is located. Eg. "42". If there is no specific identifier, use
seatAssigment
instead.
- The identifier of where the ticketed seat is located. Eg. "42". If there is no specific identifier, use
seat-assignment.default-value kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=lorem
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=ut
- The UTF-8 encoded translated string.
-
.. kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
...transit-operator-name.default-value kind=voluptua.
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=kasd
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=et
- The UTF-8 encoded translated string.
-
.. kind=invidunt
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..transit-terminus-name.default-value kind=ut
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=dolores
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=duo
- The UTF-8 encoded translated string.
-
.. kind=dolor
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
.. zone=et
- The zone of boarding within the platform.
-
.. ticket-number=tempor
- The number of the ticket. This is a unique identifier for the ticket in the transit operator's system.
ticket-restrictions.other-restrictions.default-value kind=voluptua.
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=sanctus
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=diam
- The UTF-8 encoded translated string.
-
.. kind=sadipscing
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..route-restrictions.default-value kind=stet
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=no
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=et
- The UTF-8 encoded translated string.
-
.. kind=elitr
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..route-restrictions-details.default-value kind=ea
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=dolor
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=dolor
- The UTF-8 encoded translated string.
-
.. kind=et
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
..time-restrictions.default-value kind=magna
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#translatedString"
.
- Identifies what kind of resource this is. Value: the fixed string
language=eos
- Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
-
value=elitr
- The UTF-8 encoded translated string.
-
.. kind=sanctus
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#localizedString"
.
- Identifies what kind of resource this is. Value: the fixed string
-
... ticket-status=stet
- The status of the ticket. For states which affect display, use the
state
field instead.
- The status of the ticket. For states which affect display, use the
trip-id=diam
- This id is used to group tickets together if the user has saved multiple tickets for the same trip.
trip-type=ea
- Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
-
valid-time-interval.end date=vero
- 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 of2018-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 of2018-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.
- 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:
-
.. kind=clita
- Identifies what kind of resource this is. Value: the fixed string
"walletobjects#timeInterval"
.
- Identifies what kind of resource this is. Value: the fixed string
-
start date=consetetur
- 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 of2018-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 of2018-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.
- 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:
-
... version=no
- Deprecated
About Cursors
The cursor position is key to comfortably set complex nested structures. The following rules apply:
- The cursor position is always set relative to the current one, unless the field name starts with the
.
character. Fields can be nested such as in-r f.s.o
. - The cursor position is set relative to the top-level structure if it starts with
.
, e.g.-r .s.s
- You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify
-r struct.sub_struct=bar
. - You can move the cursor one level up by using
..
. Each additional.
moves it up one additional level. E.g....
would go three levels up.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").