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)
  }
}
フィールド
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 トリプレットの省略形も使用できます。

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[]

object (LatLongPoint)

注: 現在、このフィールドは位置情報に関する通知のトリガーに対応していません。

hasUsers

boolean

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

smartTapRedemptionValue

string

このオブジェクトについて、NFC 経由でスマートタップ認定端末に送信される値。パスでスマートタップをサポートするには、クラスレベルのフィールド enableSmartTapredemptionIssuers も正しく設定する必要があります。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 とスクリーンショットの動作の制限も含まれます。

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

イベント予約の確認コード。「注文番号」、「確認番号」、「予約番号」など、さまざまな形式で表します。

Methods

addmessage

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

get

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

insert

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

list

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

modifylinkedofferobjects

指定された ID のイベント チケット オブジェクトのリンク済みクーポン オブジェクトを変更します。

patch

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

update

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