REST Resource: eventticketobject

リソース: EventTicketObject

JSON 表現 
{
  "kind": string,
  "classReference": {
    object (EventTicketClass)
  },
  "seatInfo": {
    object (EventSeat)
  },
  "reservationInfo": {
    object (EventReservationInfo)
  },
  "ticketHolderName": string,
  "ticketNumber": string,
  "ticketType": {
    object (LocalizedString)
  },
  "faceValue": {
    object (Money)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "linkedOfferIds": [
    string
  ],
  "hexBackgroundColor": string,
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
フィールド
kind
(deprecated)

string

リソースの種類を示します。値は固定文字列 "walletobjects#eventTicketObject" です。
classReference

object (EventTicketClass)

親クラスの継承されたフィールドのコピー。これらのフィールドは GET 中に取得されます。
seatInfo

object (EventSeat)

このチケットの座席の詳細。
reservationInfo

object (EventReservationInfo)

このチケットの予約の詳細。これは、同じ注文で購入されたすべてのチケットで共有されます。
ticketHolderName

string

チケット所有者の名前（チケットが人に割り当てられている場合）。たとえば、「John Doe」や「Jane Doe」です。
ticketNumber

string

チケットの番号。これには、発行者のシステム内のすべてのチケットに対して一意の識別子、イベントのすべてのチケット対して一意の識別子（例: XYZ1234512345）、同一注文のすべてのチケット対して一意の識別子（例: 1、2、3）を指定できます。
ticketType

object (LocalizedString)

チケットの種類（「大人」、「子供」、「VIP」、「スタンダード」など）。
faceValue

object (Money)

チケットの額面価格。紙のチケットに印刷された価格と一致します。
groupingInfo

object (GroupingInfo)

パスのグループ化に関する情報。
linkedOfferIds[]

string

このイベント チケットにリンクされているクーポン オブジェクトのリスト。クーポン オブジェクトがすでに存在している必要があります。

クーポン オブジェクト ID は issuer ID の形式で指定してください。identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。
hexBackgroundColor

string

カードの背景色。設定されていない場合は、ヒーロー画像の主要色が使用され、ヒーロー画像が設定されていない場合は、ロゴの主要色が使用されます。形式は #rrggbb です。ここで rrggbb は 16 進数の RGB トリプレットです（例: #ffcc00）。#fc0 など、RGB トリプレットの省略形 #rgb も使用できます。
id

string

必須。オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意の識別子には、英数字、「.」、「_」、「-」のみを使用してください。
classId

string

必須。このオブジェクトに関連付けられているクラス。クラスはこのオブジェクトと同じ型で、すでに存在し、承認される必要があります。

クラス ID は、issuer ID.identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。
version
(deprecated)

string (int64 format)

非推奨
state

enum (State)

必須。オブジェクトの状態。このフィールドは、アプリでのオブジェクトの表示方法を決定するために使用されます。たとえば、inactive オブジェクトを「期限切れのパス」セクションに移動する場合に使用します。
barcode

object (Barcode)

バーコードのタイプと値。
messages[]

object (Message)

アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受け取ります。これらのフィールドの最大数は 10 です。
validTimeInterval

object (TimeInterval)

このオブジェクトが active になり、オブジェクトが使用可能である期間。この期間が経過すると、オブジェクトの状態は expired に変更されます。
locations[]
(deprecated)

object (LatLongPoint)

注: 現在、このフィールドはジオフェンス通知のトリガーには対応していません。
hasUsers

boolean

オブジェクトにユーザーが存在するかどうかを示します。このフィールドはプラットフォームによって設定されます。
smartTapRedemptionValue

string

このオブジェクトについて、NFC を介してスマートタップ認定端末に送信される値。パスがスマートタップをサポートするには、クラスレベルのフィールド enableSmartTap と redemptionIssuers も正しく設定する必要があります。ASCII 文字のみがサポートされています。
hasLinkedDevice

boolean

このオブジェクトが現在 1 つのデバイスにリンクされているかどうか。このフィールドは、ユーザーがオブジェクトを保存し、デバイスにリンクするときに、プラットフォームによって設定されます。一部のパートナーによる使用を想定しています。詳細については、サポートにお問い合わせください。
disableExpirationNotification

boolean

通知を明示的に止めるかどうかを示します。このフィールドを true に設定した場合、messages フィールドに関係なく、ユーザーへの有効期限通知が抑制されます。デフォルトでは、このフィールドは false に設定されています。

現在、これは特典に対してのみ設定できます。
infoModuleData

object (InfoModuleData)

非推奨です。代わりに textModulesData を使用してください。
imageModulesData[]

object (ImageModuleData)

画像モジュールのデータ。このフィールドが表示される数には上限があり、オブジェクト レベルから 1 個、クラス オブジェクト レベルでは 1 個が最大数になります。
textModulesData[]

object (TextModuleData)

テキスト モジュールのデータ。テキスト モジュールのデータもクラスに定義されている場合は、両方が表示されます。このフィールドが表示される数には上限があり、オブジェクトから 10 個、クラスから 10 個が最大数になります。
rotatingBarcode

object (RotatingBarcode)

回転バーコードのタイプと値。
heroImage

object (Image)

カードの表面に表示されるオプションのバナー画像。存在しない場合、クラスのヒーロー画像（存在する場合）が表示されます。クラスのヒーロー画像も存在しない場合、何も表示されません。
passConstraints

object (PassConstraints)

オブジェクトの制約を渡します。NFC とスクリーンショットの動作の制限が含まれます。
saveRestrictions

object (SaveRestrictions)

ユーザーがパスを保存しようとする前に確認が必要なオブジェクトの制限。この制限は、保存時間中にのみ適用されます。ユーザーがパスを保存した後に制限が変更された場合、すでに保存されているパスに新しい制限は適用されません。
linkedObjectIds[]

string

linkedObjectIds は、このイベント チケット オブジェクトに自動的に関連付けられる他のオブジェクト（イベント チケット、ポイントカード、クーポン、汎用、ギフトカード、交通機関のパス、搭乗券など）のリストです。ユーザーがこのイベント チケットを保存していた場合、これらの linkdObjectIds は自動的にユーザーのウォレットにプッシュされます（ユーザーがそのようなリンクされたパスを受け取る設定を無効にした場合を除く）。

linkedObjectIds に存在するオブジェクトがすでに挿入されていることを確認します。挿入されていない場合、呼び出しは失敗します。リンクしたオブジェクトのリンクは解除できません。別のカード発行会社に属するオブジェクトをリンクすることはできません。1 つのオブジェクトにリンクできるオブジェクトの数には上限があります。上限に達すると、呼び出し内の新しいリンクされたオブジェクトは通知なく無視されます。

オブジェクト ID は issuer ID の形式にする必要があります。identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。
notifyPreference

enum (NotificationSettingsForUpdates)

このオブジェクトのフィールドの更新を通知のトリガーにするかどうか。NOTIFY に設定すると、フィールドの更新通知がユーザーに送信されます。これらの通知は、フィールドが許可リストに含まれている場合にのみユーザーに送信されます。DO_NOT_NOTIFY または NOTIFICATION_SETTINGS_UNSPECIFIED に設定した場合、通知はトリガーされません。この設定は一時的な設定であり、PATCH リクエストまたは UPDATE リクエストごとに設定する必要があります。設定しない場合、通知はトリガーされません。
valueAddedModuleData[]

object (ValueAddedModuleData)

オプションの付加価値モジュール データ。オブジェクトに最大 10 個。

EventSeat

JSON 表現 
{
  "kind": string,
  "seat": {
    object (LocalizedString)
  },
  "row": {
    object (LocalizedString)
  },
  "section": {
    object (LocalizedString)
  },
  "gate": {
    object (LocalizedString)
  }
}
フィールド
kind
(deprecated)

string

リソースの種類を示します。値は固定文字列 "walletobjects#eventSeat" です。
seat

object (LocalizedString)

座席番号（「1」、「2」、「3」など）またはその他の座席識別子。

このフィールドはローカライズ可能なため、単語を翻訳したり、識別子の文字に別のアルファベットを使用したりできます。
row

object (LocalizedString)

座席の列（「1」、「E」、「BB」、「A5」など）。

このフィールドはローカライズ可能であるため、語句を翻訳したり、識別子の文字に別のアルファベットを使用したりできます。
section

object (LocalizedString)

座席のセクション（「121」など）。

このフィールドはローカライズ可能であるため、語句を翻訳したり、識別子の文字に別のアルファベットを使用したりできます。
gate

object (LocalizedString)

チケット所有者が自分の座席にたどり着くために使用するゲート（「A」や「West」など）。

このフィールドはローカライズ可能であるため、語句を翻訳したり、識別子の文字に別のアルファベットを使用したりできます。

EventReservationInfo

JSON 表現 
{
  "kind": string,
  "confirmationCode": string
}
フィールド
kind
(deprecated)

string

リソースの種類を示します。値は固定文字列 "walletobjects#eventReservationInfo" です。
confirmationCode

string

イベント予約の確認コード。これは、「注文番号」、「確認番号」、「予約番号」などと呼ばれることもあります。

メソッド

addmessage

 指定されたオブジェクト ID のイベント チケット オブジェクトにメッセージを追加します。

get

 指定されたオブジェクト ID のイベント チケット オブジェクトを返します。

insert

 指定された ID とプロパティのイベント チケット オブジェクトを挿入します。

list

 指定された発行者 ID のすべてのイベント チケット オブジェクトのリストを返します。

modifylinkedofferobjects

 指定された ID のイベント チケット オブジェクトについて、リンク済みクーポン オブジェクトを修正します。

patch

 指定されたオブジェクト ID のイベント チケット オブジェクトを更新します。

update

 指定されたオブジェクト ID のイベント チケット オブジェクトを更新します。