Package google.walletobjects.v1

Index

AddMessageRequest (message)
AppLinkData (message)
AppLinkData.AppLinkInfo (message)
AppLinkData.AppLinkInfo.AppTarget (message)
Barcode (message)
BarcodeRenderEncoding (enum)
BarcodeType (enum)
CallbackOptions (message)
DateTime (message)
DiscoverableProgram (message)
DiscoverableProgram.State (enum)
DiscoverableProgramMerchantSigninInfo (message)
DiscoverableProgramMerchantSignupInfo (message)
DiscoverableProgramMerchantSignupInfo.SharedDataType (enum)
GroupingInfo (message)
Image (message)
ImageModuleData (message)
ImageUri (message)
InfoModuleData (message)
LabelValue (message)
LabelValueRow (message)
LatLongPoint (message)
LinksModuleData (message)
LocalizedString (message)
Message (message)
Message.MessageType (enum)
ModifyLinkedOfferObjects (message)
ModifyLinkedOfferObjectsRequest (message)
Money (message)
MultipleDevicesAndHoldersAllowedStatus (enum)
Pagination (message)
Review (message)
ReviewStatus (enum)
State (enum)
TextModuleData (message)
TimeInterval (message)
TranslatedString (message)
Uri (message)

AddMessageRequest

Resource used when the AddMessage endpoints are called.

Fields
`message`	`Message`

AppLinkData

Fields

Fields
`android_app_link_info`	`AppLinkInfo` Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
`ios_app_link_info`	`AppLinkInfo` Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the ios client.
`web_app_link_info`	`AppLinkInfo` Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.

android_app_link_info

AppLinkInfo

Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.

ios_app_link_info

AppLinkInfo

Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the ios client.

web_app_link_info

AppLinkInfo

Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.

AppLinkInfo

Fields
`app_logo_image`	`Image` Optional image to be displayed in the App Link Module
`title`	`LocalizedString` String to be displayed in the title of the App Link Module Required
`description`	`LocalizedString` String to be displayed in the description of the App Link Module Required
`app_target`	`AppTarget` Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app.

AppTarget

Fields
`target_uri`	`Uri`

Barcode

Fields
`kind (deprecated)`	`string` This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
`type`	`BarcodeType` The type of barcode.
`render_encoding`	`BarcodeRenderEncoding` The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
`value`	`string` The value encoded in the barcode.
`alternate_text`	`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.
`show_code_text`	`LocalizedString` Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.

BarcodeRenderEncoding

Enums
`RENDER_ENCODING_UNSPECIFIED`
`UTF_8`	UTF_8 encoding for barcodes. This is only supported for barcode type qrCode.

BarcodeType

Enums
`BARCODE_TYPE_UNSPECIFIED`
`AZTEC`
`aztec`	Legacy alias for `AZTEC`. Deprecated. This item is deprecated!
`CODE_39`
`code39`	Legacy alias for `CODE_39`. Deprecated. This item is deprecated!
`CODE_128`
`code128`	Legacy alias for `CODE_128`. Deprecated. This item is deprecated!
`CODABAR`
`codabar`	Legacy alias for `CODABAR`. Deprecated. This item is deprecated!
`DATA_MATRIX`	A 2D matrix barcode consisting of black and white. Cells or modules are arranged in either a square or rectangle.
`dataMatrix`	Legacy alias for `DATA_MATRIX`. Deprecated. This item is deprecated!
`EAN_8`
`ean8`	Legacy alias for `EAN_8`. Deprecated. This item is deprecated!
`EAN_13`
`ean13`	Legacy alias for `EAN_13`. Deprecated. This item is deprecated!
`EAN13`	Legacy alias for `EAN_13`. Deprecated. This item is deprecated!
`ITF_14`	14 digit ITF code
`itf14`	Legacy alias for `ITF_14`. Deprecated. This item is deprecated!
`PDF_417`
`pdf417`	Legacy alias for `PDF_417`. Deprecated. This item is deprecated!
`PDF417`	Legacy alias for `PDF_417`. Deprecated. This item is deprecated!
`QR_CODE`
`qrCode`	Legacy alias for `QR_CODE`. Deprecated. This item is deprecated!
`qrcode`	Legacy alias for `QR_CODE`. Deprecated. This item is deprecated!
`UPC_A`	11 or 12 digit codes
`upcA`	Legacy alias for `UPC_A`. Deprecated. This item is deprecated!
`TEXT_ONLY`	Renders the field as a text field. The `alternateText` field may not be used with a barcode of type `textOnly`.
`textOnly`	Legacy alias for `TEXT_ONLY`. Deprecated. This item is deprecated!

CallbackOptions

Fields

Fields
`url`	`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:Google-Valuables.
`update_request_url`	`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:Google-Valuables. Please contact Google support before using this field.

url

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:Google-Valuables.

update_request_url

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:Google-Valuables.

Please contact Google support before using this field.

DateTime

Fields

Fields
`date`	`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.

date

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.

DiscoverableProgram

Information about how a class may be discovered and instantiated from within the Android Pay app. This is done by searching for a loyalty or gift card program and scanning or manually entering.

Fields

Fields
`merchant_signup_info`	`DiscoverableProgramMerchantSignupInfo` Information about the ability to signup and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNUP is enabled.
`merchant_signin_info`	`DiscoverableProgramMerchantSigninInfo` Information about the ability to signin and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNIN is enabled.
`state`	`State` Visibility state of the discoverable program.

merchant_signup_info

DiscoverableProgramMerchantSignupInfo

Information about the ability to signup and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNUP is enabled.

merchant_signin_info

DiscoverableProgramMerchantSigninInfo

Information about the ability to signin and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNIN is enabled.

state

State

Visibility state of the discoverable program.

State

Enums
`STATE_UNSPECIFIED`
`TRUSTED_TESTERS`	Visible only to testers that have access to issuer account.
`trustedTesters`	Legacy alias for `TRUSTED_TESTERS`. Deprecated. This item is deprecated!
`LIVE`	Visible to all.
`live`	Legacy alias for `LIVE`. Deprecated. This item is deprecated!
`DISABLED`	Not visible.
`disabled`	Legacy alias for `DISABLED`. Deprecated. This item is deprecated!

DiscoverableProgramMerchantSigninInfo

Information about the merchant hosted signin flow for a program.

Fields

Fields
`signin_website`	`Uri` The URL to direct the user to for the merchant's signin site.

signin_website

Uri

The URL to direct the user to for the merchant's signin site.

DiscoverableProgramMerchantSignupInfo

Information about the merchant hosted signup flow for a program.

Fields

Fields
`signup_website`	`Uri` The URL to direct the user to for the merchant's signup site.
`signup_shared_datas[]`	`SharedDataType` User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program.

signup_website

Uri

The URL to direct the user to for the merchant's signup site.

signup_shared_datas[]

SharedDataType

User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program.

SharedDataType

Enums
`SHARED_DATA_TYPE_UNSPECIFIED`
`FIRST_NAME`
`LAST_NAME`
`STREET_ADDRESS`	single line address field
`ADDRESS_LINE_1`	multi line address fields
`ADDRESS_LINE_2`
`ADDRESS_LINE_3`
`CITY`
`STATE`
`ZIPCODE`
`COUNTRY`
`EMAIL`
`PHONE`

GroupingInfo

NEXT_ID: 2

Fields

Fields
`sort_index`	`int32` 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 same sort index, the sorting behavior is undefined.

sort_index

int32

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 same sort index, the sorting behavior is undefined.

Image

Wrapping type for Google hosted images.

Fields

Fields
`kind (deprecated)`	`string` This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#image"`.
`source_uri`	`ImageUri` The URI for the image.

kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".

source_uri

ImageUri

The URI for the image.

ImageModuleData

Fields

Fields
`main_image`	`Image` A 100% width image.
`id`	`string` The ID associated with an image module. This field is here to enable ease of management of image modules.

main_image

Image

A 100% width image.

id

string

The ID associated with an image module. This field is here to enable ease of management of image modules.

ImageUri

Fields

Fields
`uri`	`string` The location of the image. URIs must have a scheme.
`description (deprecated)`	`string` This item is deprecated! Additional information about the image, which is unused and retained only for backward compatibility.
`localized_description (deprecated)`	`LocalizedString` This item is deprecated! Translated strings for the description, which are unused and retained only for backward compatibility.

uri

string

The location of the image. URIs must have a scheme.

description
(deprecated)

string

Additional information about the image, which is unused and retained only for backward compatibility.

localized_description
(deprecated)

LocalizedString

Translated strings for the description, which are unused and retained only for backward compatibility.

InfoModuleData

Fields

Fields
`label_value_rows[]`	`LabelValueRow` A list of collections of labels and values. These will be displayed one after the other in a singular column.
`show_last_update_time (deprecated)`	`bool` This item is deprecated!

label_value_rows[]

LabelValueRow

A list of collections of labels and values. These will be displayed one after the other in a singular column.

show_last_update_time
(deprecated)

bool

LabelValue

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.

Fields
`label`	`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.
`value`	`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.
`localized_label`	`LocalizedString` Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
`localized_value`	`LocalizedString` Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.

LabelValueRow

Fields

Fields
`columns[]`	`LabelValue` 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.

columns[]

LabelValue

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.

LatLongPoint

Fields

Fields
`kind (deprecated)`	`string` This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
`latitude`	`double` 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`	`double` The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.

kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#latLongPoint".

latitude

double

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

double

The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.

LinksModuleData

Fields

Fields
`uris[]`	`Uri` The list of URIs.

uris[]

Uri

The list of URIs.

LocalizedString

Fields

Fields
`kind (deprecated)`	`string` This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`.
`translated_values[]`	`TranslatedString` Contains the translations for the string.
`default_value`	`TranslatedString` Contains the string to be displayed if no appropriate translation is available.

kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

translated_values[]

TranslatedString

Contains the translations for the string.

default_value

TranslatedString

Contains the string to be displayed if no appropriate translation is available.

Message

A message that will be displayed with a Valuable

Fields
`kind (deprecated)`	`string` This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.
`header`	`string` The message header.
`body`	`string` The message body.
`display_interval`	`TimeInterval` 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.
`id`	`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.
`message_type`	`MessageType` The type of the message. Currently, this can only be set for offers.
`localized_header`	`LocalizedString` Translated strings for the message header.
`localized_body`	`LocalizedString` Translated strings for the message body.

MessageType

Enums
`MESSAGE_TYPE_UNSPECIFIED`
`TEXT`	Renders the message as text on the card details screen. This is the default message type.
`text`	Legacy alias for `TEXT`. Deprecated. This item is deprecated!
`EXPIRATION_NOTIFICATION`	Notification to display for an offer expiration. The `displayInterval.start.date` sets the time the notification will appear. It can be set up to 30 days prior to the expiration date. If a time span greater than this is specified, then the notification will trigger at the 30 day mark.
`expirationNotification`	Legacy alias for `EXPIRATION_NOTIFICATION`. Deprecated. This item is deprecated!

ModifyLinkedOfferObjects

Fields

Fields
`add_linked_offer_object_ids[]`	`string` The linked offer object ids to add to the object.
`remove_linked_offer_object_ids[]`	`string` The linked offer object ids to remove from the object.

add_linked_offer_object_ids[]

string

The linked offer object ids to add to the object.

remove_linked_offer_object_ids[]

string

The linked offer object ids to remove from the object.

ModifyLinkedOfferObjectsRequest

Fields

Fields
`linked_offer_object_ids`	`ModifyLinkedOfferObjects` The linked offer object ids to add or remove from the object.

linked_offer_object_ids

ModifyLinkedOfferObjects

The linked offer object ids to add or remove from the object.

Money

Fields

Fields
`kind (deprecated)`	`string` This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#money"`.
`micros`	`int64` The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.
`currency_code`	`string` The currency code, such as "USD" or "EUR."

kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#money".

micros

int64

The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.

currency_code

string

The currency code, such as "USD" or "EUR."

MultipleDevicesAndHoldersAllowedStatus

Enums
`STATUS_UNSPECIFIED`
`MULTIPLE_HOLDERS`	Multiple users on multiple devices are allowed.
`multipleHolders`	Legacy alias for `MULTIPLE_HOLDERS`. Deprecated. This item is deprecated!
`ONE_USER_ALL_DEVICES`	One user on multiple devices is allowed.
`oneUserAllDevices`	Legacy alias for `ONE_USER_ALL_DEVICES`. Deprecated. This item is deprecated!
`ONE_USER_ONE_DEVICE`	Intended for use by select partners in limited circumstances. Contact support for additional information.
`oneUserOneDevice`	Legacy alias for `ONE_USER_ONE_DEVICE`. Deprecated. This item is deprecated!

Pagination

Fields

Fields
`kind (deprecated)`	`string` This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#pagination"`.
`results_per_page`	`int32` Number of results returned in this page.
`next_page_token`	`string` Page token to send to fetch the next page.

kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#pagination".

results_per_page

int32

Number of results returned in this page.

next_page_token

string

Page token to send to fetch the next page.

Review

Fields
`comments`	`string`

ReviewStatus

Enums
`REVIEW_STATUS_UNSPECIFIED`
`UNDER_REVIEW`
`underReview`	Legacy alias for `UNDER_REVIEW`. Deprecated. This item is deprecated!
`APPROVED`
`approved`	Legacy alias for `APPROVED`. Deprecated. This item is deprecated!
`REJECTED`
`rejected`	Legacy alias for `REJECTED`. Deprecated. This item is deprecated!
`DRAFT`
`draft`	Legacy alias for `DRAFT`. Deprecated. This item is deprecated!

State

Enums
`STATE_UNSPECIFIED`
`ACTIVE`	Object is active and displayed to with other active objects.
`active`	Legacy alias for `ACTIVE`. Deprecated. This item is deprecated!
`COMPLETED`
`completed`	Legacy alias for `COMPLETED`. Deprecated. This item is deprecated!
`EXPIRED`	Object is no longer valid (`validTimeInterval` passed).
`expired`	Legacy alias for `EXPIRED`. Deprecated. This item is deprecated!
`INACTIVE`
`inactive`	Legacy alias for `INACTIVE`. Deprecated. This item is deprecated!

TextModuleData

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.

Fields
`header`	`string` The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
`body`	`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.
`localized_header`	`LocalizedString` Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
`localized_body`	`LocalizedString` Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
`id`	`string` The ID associated with a text module. This field is here to enable ease of management of text modules.

TimeInterval

Fields

Fields
`kind (deprecated)`	`string` This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`.
`start`	`DateTime` 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.
`end`	`DateTime` 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.

kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#timeInterval".

start

DateTime

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.

end

DateTime

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.

TranslatedString

Fields

Fields
`kind (deprecated)`	`string` This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
`language`	`string` Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
`value`	`string` The UTF-8 encoded translated string.

kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".

language

string

Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

value

string

The UTF-8 encoded translated string.

Uri

Fields
`kind (deprecated)`	`string` This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#uri"`.
`uri`	`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`	`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.
`localized_description`	`LocalizedString` Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
`id`	`string` The ID associated with a uri. This field is here to enable ease of management of uris.