/walletobjects/v1/eventTicketObject/{resourceId}/modifyLinkedOfferObjects

POST

eventticketobject

Modifies linked offer objects for the event ticket object with the given ID.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://walletobjects.googleapis.com//walletobjects/v1/eventTicketObject//modifyLinkedOfferObjects' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

Request

Path Params

resourceId

string

required

The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.

Body Params application/json

linkedOfferObjectIds

object (ModifyLinkedOfferObjects)

optional

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

addLinkedOfferObjectIds

array[string]

optional

The linked offer object ids to add to the object.

removeLinkedOfferObjectIds

array[string]

optional

The linked offer object ids to remove from the object.

Examples

Responses

🟢200Successful response

application/json

Body

appLinkData

object (AppLinkData)

optional

Optional information about the partner app link.

androidAppLinkInfo

object (AppLinkDataAppLinkInfo)

optional

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.

iosAppLinkInfo

object (AppLinkDataAppLinkInfo)

optional

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.

webAppLinkInfo

object (AppLinkDataAppLinkInfo)

optional

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.

barcode

object (Barcode)

optional

The barcode type and value.

alternateText

string

optional

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

string

optional

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

renderEncoding

enum<string>

optional

The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.

Allowed values:

RENDER_ENCODING_UNSPECIFIEDUTF_8

showCodeText

object (LocalizedString)

optional

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.

type

enum<string>

optional

The type of barcode.

Allowed values:

BARCODE_TYPE_UNSPECIFIEDAZTECaztecCODE_39code39CODE_128code128CODABARcodabarDATA_MATRIXdataMatrixEAN_8ean8EAN_13ean13EAN13ITF_14itf14PDF_417pdf417PDF417QR_CODEqrCodeqrcodeUPC_AupcATEXT_ONLYtextOnly

value

string

optional

The value encoded in the barcode.

classId

string

optional

Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.

classReference

object (EventTicketClass)

optional

A copy of the inherited fields of the parent class. These fields are retrieved during a GET.

allowMultipleUsersPerObject

boolean

optional

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.

callbackOptions

object (CallbackOptions)

optional

Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.

classTemplateInfo

object (ClassTemplateInfo)

optional

Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.

confirmationCodeLabel

enum<string>

optional

The label to use for the confirmation code value (eventTicketObject.reservationInfo.confirmationCode) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both confirmationCodeLabel and customConfirmationCodeLabel may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.

Allowed values:

CONFIRMATION_CODE_LABEL_UNSPECIFIEDCONFIRMATION_CODEconfirmationCodeCONFIRMATION_NUMBERconfirmationNumberORDER_NUMBERorderNumberRESERVATION_NUMBERreservationNumber

countryCode

string

optional

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.

customConfirmationCodeLabel

object (LocalizedString)

optional

A custom label to use for the confirmation code value (eventTicketObject.reservationInfo.confirmationCode) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the confirmationCodeLabel options is not sufficient. Both confirmationCodeLabel and customConfirmationCodeLabel may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.

customGateLabel

object (LocalizedString)

optional

A custom label to use for the gate value (eventTicketObject.seatInfo.gate) on the card detail view. This should only be used if the default "Gate" label or one of the gateLabel options is not sufficient. Both gateLabel and customGateLabel may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.

customRowLabel

object (LocalizedString)

optional

A custom label to use for the row value (eventTicketObject.seatInfo.row) on the card detail view. This should only be used if the default "Row" label or one of the rowLabel options is not sufficient. Both rowLabel and customRowLabel may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.

customSeatLabel

object (LocalizedString)

optional

A custom label to use for the seat value (eventTicketObject.seatInfo.seat) on the card detail view. This should only be used if the default "Seat" label or one of the seatLabel options is not sufficient. Both seatLabel and customSeatLabel may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.

customSectionLabel

object (LocalizedString)

optional

A custom label to use for the section value (eventTicketObject.seatInfo.section) on the card detail view. This should only be used if the default "Section" label or one of the sectionLabel options is not sufficient. Both sectionLabel and customSectionLabel may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.

dateTime

object (EventDateTime)

optional

The date & time information of the event.

enableSmartTap

boolean

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

eventId

string

optional

The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the classId (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).

eventName

object (LocalizedString)

optional

Required. The name of the event, such as "LA Dodgers at SF Giants".

finePrint

object (LocalizedString)

optional

The fine print, terms, or conditions of the ticket.

gateLabel

enum<string>

optional

The label to use for the gate value (eventTicketObject.seatInfo.gate) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both gateLabel and customGateLabel may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.

Allowed values:

GATE_LABEL_UNSPECIFIEDGATEgateDOORdoorENTRANCEentrance

heroImage

object (Image)

optional

Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.

hexBackgroundColor

string

optional

The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as #ffcc00. You can also use the shorthand version of the RGB triplet which is #rgb, such as #fc0.

homepageUri

object (Uri)

optional

The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).

string

optional

Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.

imageModulesData

array[object (ImageModuleData) {2}]

optional

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.

infoModuleData

object (InfoModuleData)

optional

Deprecated. Use textModulesData instead.

issuerName

string

optional

Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

kind

string

optional

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

linksModuleData

object (LinksModuleData)

optional

Links module data. If links module data is also defined on the object, both will be displayed.

localizedIssuerName

object (LocalizedString)

optional

Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

locations

array[object (LatLongPoint) {3}]

optional

logo

object (Image)

optional

The logo image of the ticket. This image is displayed in the card detail view of the app.

messages

array[object (Message) {8}]

optional

An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.

multipleDevicesAndHoldersAllowedStatus

enum<string>

optional

Identifies whether multiple users and devices will save the same object referencing this class.

Allowed values:

STATUS_UNSPECIFIEDMULTIPLE_HOLDERSmultipleHoldersONE_USER_ALL_DEVICESoneUserAllDevicesONE_USER_ONE_DEVICEoneUserOneDevice

redemptionIssuers

array[string <int64>]

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

review

object (Review)

optional

The review comments set by the platform when a class is marked approved or rejected.

reviewStatus

enum<string>

optional

Required. The status of the class. This field can be set to draft or underReview using the insert, patch, or update API calls. Once the review state is changed from draft it may not be changed back to draft. You should keep this field to draft when the class is under development. A draft class cannot be used to create any object. You should set this field to underReview when you believe the class is ready for use. The platform will automatically set this field to approved and it can be immediately used to create or migrate objects. When updating an already approved class you should keep setting this field to underReview.

Allowed values:

REVIEW_STATUS_UNSPECIFIEDUNDER_REVIEWunderReviewAPPROVEDapprovedREJECTEDrejectedDRAFTdraft

rowLabel

enum<string>

optional

The label to use for the row value (eventTicketObject.seatInfo.row) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both rowLabel and customRowLabel may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.

Allowed values:

ROW_LABEL_UNSPECIFIEDROWrow

seatLabel

enum<string>

optional

The label to use for the seat value (eventTicketObject.seatInfo.seat) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both seatLabel and customSeatLabel may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.

Allowed values:

SEAT_LABEL_UNSPECIFIEDSEATseat

sectionLabel

enum<string>

optional

The label to use for the section value (eventTicketObject.seatInfo.section) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both sectionLabel and customSectionLabel may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.

Allowed values:

SECTION_LABEL_UNSPECIFIEDSECTIONsectionTHEATERtheater

securityAnimation

object (SecurityAnimation)

optional

Optional information about the security animation. If this is set a security animation will be rendered on pass details.

textModulesData

array[object (TextModuleData) {5}]

optional

Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.

venue

object (EventVenue)

optional

Event venue details.

version

string <int64>

optional

Deprecated

wordMark

object (Image)

optional

Deprecated.

disableExpirationNotification

boolean

optional

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.

faceValue

object (Money)

optional

The face value of the ticket, matching what would be printed on a physical version of the ticket.

currencyCode

string

optional

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

kind

string

optional

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

micros

string <int64>

optional

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

groupingInfo

object (GroupingInfo)

optional

Grouping info for event tickets.

sortIndex

integer <int32>

optional

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.

hasLinkedDevice

boolean

optional

Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.

hasUsers

boolean

optional

Indicates if the object has users. This field is set by the platform.

heroImage

object (Image)

optional

Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.

hexBackgroundColor

string

optional

string

optional

Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.

imageModulesData

array[object (ImageModuleData) {2}]

optional

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.

string

optional

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

mainImage

object (Image)

optional

A 100% width image.

infoModuleData

object (InfoModuleData)

optional

Deprecated. Use textModulesData instead.

kind

string

optional

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

linkedOfferIds

array[string]

optional

A list of offer objects linked to this event ticket. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.

linksModuleData

object (LinksModuleData)

optional

Links module data. If links module data is also defined on the class, both will be displayed.

locations

array[object (LatLongPoint) {3}]

optional

The list of locations where the object can be used. The platform uses this information to trigger geolocated notifications to users. Note that locations in the object override locations in the class which override locations in the Google Places ID.

kind

string

optional

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

latitude

number <double>

optional

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

number <double>

optional

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

messages

array[object (Message) {8}]

optional

An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.

body

string

optional

The message body.

displayInterval

object (TimeInterval)

optional

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.

header

string

optional

The message header.

string

optional

The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.

kind

string

optional

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

localizedBody

object (LocalizedString)

optional

Translated strings for the message body.

localizedHeader

object (LocalizedString)

optional

Translated strings for the message header.

messageType

enum<string>

optional

The type of the message. Currently, this can only be set for offers.

Allowed values:

MESSAGE_TYPE_UNSPECIFIEDTEXTtextEXPIRATION_NOTIFICATIONexpirationNotification

reservationInfo

object (EventReservationInfo)

optional

Reservation details for this ticket. This is expected to be shared amongst all tickets that were purchased in the same order.

confirmationCode

string

optional

The confirmation code of the event reservation. This may also take the form of an "order number", "confirmation number", "reservation number", or other equivalent.

kind

string

optional

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

seatInfo

object (EventSeat)

optional

Seating details for this ticket.

gate

object (LocalizedString)

optional

The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.

kind

string

optional

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

row

object (LocalizedString)

optional

The row of the seat, such as "1", E", "BB", or "A5". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.

seat

object (LocalizedString)

optional

The seat number, such as "1", "2", "3", or any other seat identifier. This field is localizable so you may translate words or use different alphabets for the characters in an identifier.

section

object (LocalizedString)

optional

The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.

smartTapRedemptionValue

string

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

state

enum<string>

optional

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.

Allowed values:

STATE_UNSPECIFIEDACTIVEactiveCOMPLETEDcompletedEXPIREDexpiredINACTIVEinactive

textModulesData

array[object (TextModuleData) {5}]

optional

Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.

body

string

optional

The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.

header

string

optional

The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.

string

optional

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

localizedBody

object (LocalizedString)

optional

Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.

localizedHeader

object (LocalizedString)

optional

Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.

ticketHolderName

string

optional

Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".

ticketNumber

string

optional

The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).

ticketType

object (LocalizedString)

optional

The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".

validTimeInterval

object (TimeInterval)

optional

The time period this object will be active and object can be used. An object's state will be changed to expired when this time period has passed.

version

string <int64>

optional

Deprecated

Modified at 2022-09-10 16:56:46

/walletobjects/v1/eventTicketObject/{resourceId}/addMessage

/walletobjects/v1/flightClass