ClassTemplateInfo

JSON representation
 { 
 "cardBarcodeSectionDetails" 
 : 
 { 
 object (  CardBarcodeSectionDetails 
 
) 
 } 
 , 
 "cardTemplateOverride" 
 : 
 { 
 object (  CardTemplateOverride 
 
) 
 } 
 , 
 "detailsTemplateOverride" 
 : 
 { 
 object (  DetailsTemplateOverride 
 
) 
 } 
 , 
 "listTemplateOverride" 
 : 
 { 
 object (  ListTemplateOverride 
 
) 
 } 
 } 
Fields
cardBarcodeSectionDetails

object ( CardBarcodeSectionDetails )

Specifies extra information to be displayed above and below the barcode.

cardTemplateOverride

object ( CardTemplateOverride )

Override for the card view.

detailsTemplateOverride

object ( DetailsTemplateOverride )

Override for the details view (beneath the card view).

listTemplateOverride

object ( ListTemplateOverride )

Override for the passes list view.

CardBarcodeSectionDetails

JSON representation
 { 
 "firstTopDetail" 
 : 
 { 
 object (  BarcodeSectionDetail 
 
) 
 } 
 , 
 "firstBottomDetail" 
 : 
 { 
 object (  BarcodeSectionDetail 
 
) 
 } 
 , 
 "secondTopDetail" 
 : 
 { 
 object (  BarcodeSectionDetail 
 
) 
 } 
 } 
Fields
firstTopDetail

object ( BarcodeSectionDetail )

Optional information to display above the barcode. If secondTopDetail is defined, this will be displayed to the start side of this detail section.

firstBottomDetail

object ( BarcodeSectionDetail )

Optional information to display below the barcode.

secondTopDetail

object ( BarcodeSectionDetail )

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.

BarcodeSectionDetail

JSON representation
 { 
 "fieldSelector" 
 : 
 { 
 object (  FieldSelector 
 
) 
 } 
 } 
Fields
fieldSelector

object ( FieldSelector )

A reference to an existing text-based or image field to display.

FieldSelector

Custom field selector to use with field overrides.

JSON representation
 { 
 "fields" 
 : 
 [ 
 { 
 object (  FieldReference 
 
) 
 } 
 ] 
 } 
Fields
fields[]

object ( FieldReference )

If more than one reference is supplied, then the first one that references a non-empty field will be displayed.

FieldReference

Reference definition to use with field overrides.

JSON representation
 { 
 "fieldPath" 
 : 
 string 
 , 
 "dateFormat" 
 : 
 enum (  DateFormat 
 
) 
 } 
Fields
fieldPath

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".

dateFormat

enum ( DateFormat )

Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

DateFormat

DateFormat options specific to rendering date/time fields.

Enums
DATE_FORMAT_UNSPECIFIED Default option when no format is specified, when selected, no formatting will be applied.
DATE_TIME Renders 2018-12-14T13:00:00 as Dec 14, 1:00 PM in en_US .
dateTime

Legacy alias for DATE_TIME . Deprecated.

DATE_ONLY Renders 2018-12-14T13:00:00 as Dec 14 in en_US .
dateOnly

Legacy alias for DATE_ONLY . Deprecated.

TIME_ONLY Renders 2018-12-14T13:00:00 as 1:00 PM in en_US .
timeOnly

Legacy alias for TIME_ONLY . Deprecated.

DATE_TIME_YEAR Renders 2018-12-14T13:00:00 as Dec 14, 2018, 1:00 PM in en_US .
dateTimeYear

Legacy alias for DATE_TIME_YEAR . Deprecated.

DATE_YEAR Renders 2018-12-14T13:00:00 as Dec 14, 2018 in en_US .
dateYear

Legacy alias for DATE_YEAR . Deprecated.

YEAR_MONTH Renders 2018-12-14T13:00:00 as 2018-12 .
YEAR_MONTH_DAY Renders 2018-12-14T13:00:00 as 2018-12-14 .

CardTemplateOverride

JSON representation
 { 
 "cardRowTemplateInfos" 
 : 
 [ 
 { 
 object (  CardRowTemplateInfo 
 
) 
 } 
 ] 
 } 
Fields
cardRowTemplateInfos[]

object ( CardRowTemplateInfo )

Template information for rows in the card view. At most three rows are allowed to be specified.

CardRowTemplateInfo

JSON representation
 { 
 "oneItem" 
 : 
 { 
 object (  CardRowOneItem 
 
) 
 } 
 , 
 "twoItems" 
 : 
 { 
 object (  CardRowTwoItems 
 
) 
 } 
 , 
 "threeItems" 
 : 
 { 
 object (  CardRowThreeItems 
 
) 
 } 
 } 
Fields
oneItem

object ( CardRowOneItem )

Template for a row containing one item. Exactly one of "oneItem", "twoItems", "threeItems" must be set.

twoItems

object ( CardRowTwoItems )

Template for a row containing two items. Exactly one of "oneItem", "twoItems", "threeItems" must be set.

threeItems

object ( CardRowThreeItems )

Template for a row containing three items. Exactly one of "oneItem", "twoItems", "threeItems" must be set.

CardRowOneItem

JSON representation
 { 
 "item" 
 : 
 { 
 object (  TemplateItem 
 
) 
 } 
 } 
Fields
item

object ( TemplateItem )

The item to be displayed in the row. This item will be automatically centered.

TemplateItem

JSON representation
 { 
 "firstValue" 
 : 
 { 
 object (  FieldSelector 
 
) 
 } 
 , 
 "secondValue" 
 : 
 { 
 object (  FieldSelector 
 
) 
 } 
 , 
 "predefinedItem" 
 : 
 enum (  PredefinedItem 
 
) 
 } 
Fields
firstValue

object ( FieldSelector )

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".

secondValue

object ( FieldSelector )

A reference to a field to display. This may only be populated if the firstValue field is populated.

predefinedItem

enum ( PredefinedItem )

A predefined item to display. Only one of firstValue or predefinedItem may be set.

PredefinedItem

Enums
PREDEFINED_ITEM_UNSPECIFIED
FREQUENT_FLYER_PROGRAM_NAME_AND_NUMBER
frequentFlyerProgramNameAndNumber

Legacy alias for FREQUENT_FLYER_PROGRAM_NAME_AND_NUMBER . Deprecated.

FLIGHT_NUMBER_AND_OPERATING_FLIGHT_NUMBER
flightNumberAndOperatingFlightNumber

Legacy alias for FLIGHT_NUMBER_AND_OPERATING_FLIGHT_NUMBER . Deprecated.

CardRowTwoItems

JSON representation
 { 
 "startItem" 
 : 
 { 
 object (  TemplateItem 
 
) 
 } 
 , 
 "endItem" 
 : 
 { 
 object (  TemplateItem 
 
) 
 } 
 } 
Fields
startItem

object ( TemplateItem )

The item to be displayed at the start of the row. This item will be aligned to the left.

endItem

object ( TemplateItem )

The item to be displayed at the end of the row. This item will be aligned to the right.

CardRowThreeItems

JSON representation
 { 
 "startItem" 
 : 
 { 
 object (  TemplateItem 
 
) 
 } 
 , 
 "middleItem" 
 : 
 { 
 object (  TemplateItem 
 
) 
 } 
 , 
 "endItem" 
 : 
 { 
 object (  TemplateItem 
 
) 
 } 
 } 
Fields
startItem

object ( TemplateItem )

The item to be displayed at the start of the row. This item will be aligned to the left.

middleItem

object ( TemplateItem )

The item to be displayed in the middle of the row. This item will be centered between the start and end items.

endItem

object ( TemplateItem )

The item to be displayed at the end of the row. This item will be aligned to the right.

DetailsTemplateOverride

JSON representation
 { 
 "detailsItemInfos" 
 : 
 [ 
 { 
 object (  DetailsItemInfo 
 
) 
 } 
 ] 
 } 
Fields
detailsItemInfos[]

object ( DetailsItemInfo )

Information for the "nth" item displayed in the details list.

DetailsItemInfo

JSON representation
 { 
 "item" 
 : 
 { 
 object (  TemplateItem 
 
) 
 } 
 } 
Fields
item

object ( TemplateItem )

The item to be displayed in the details list.

ListTemplateOverride

JSON representation
 { 
 "firstRowOption" 
 : 
 { 
 object (  FirstRowOption 
 
) 
 } 
 , 
 "secondRowOption" 
 : 
 { 
 object (  FieldSelector 
 
) 
 } 
 , 
 "thirdRowOption" 
 : 
 { 
 object (  FieldSelector 
 
) 
 } 
 } 
Fields
firstRowOption

object ( 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.

secondRowOption

object ( FieldSelector )

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.

thirdRowOption
(deprecated)

object ( FieldSelector )

An unused/deprecated field. Setting it will have no effect on what the user sees.

FirstRowOption

JSON representation
 { 
 "transitOption" 
 : 
 enum (  TransitOption 
 
) 
 , 
 "fieldOption" 
 : 
 { 
 object (  FieldSelector 
 
) 
 } 
 } 
Fields
transitOption

enum ( TransitOption )

fieldOption

object ( FieldSelector )

A reference to the field to be displayed in the first row.

TransitOption

Enums
TRANSIT_OPTION_UNSPECIFIED
ORIGIN_AND_DESTINATION_NAMES
originAndDestinationNames

Legacy alias for ORIGIN_AND_DESTINATION_NAMES . Deprecated.

ORIGIN_AND_DESTINATION_CODES
originAndDestinationCodes

Legacy alias for ORIGIN_AND_DESTINATION_CODES . Deprecated.

ORIGIN_NAME
originName

Legacy alias for ORIGIN_NAME . Deprecated.

Create a Mobile Website
View Site in Mobile | Classic
Share by: