REST Resource: eventticketclass

リソース: EventTicketClass

JSON 表現 
{
  "kind": string,
  "eventName": {
    object (LocalizedString)
  },
  "eventId": string,
  "logo": {
    object (Image)
  },
  "venue": {
    object (EventVenue)
  },
  "dateTime": {
    object (EventDateTime)
  },
  "confirmationCodeLabel": enum (ConfirmationCodeLabel),
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "seatLabel": enum (SeatLabel),
  "customSeatLabel": {
    object (LocalizedString)
  },
  "rowLabel": enum (RowLabel),
  "customRowLabel": {
    object (LocalizedString)
  },
  "sectionLabel": enum (SectionLabel),
  "customSectionLabel": {
    object (LocalizedString)
  },
  "gateLabel": enum (GateLabel),
  "customGateLabel": {
    object (LocalizedString)
  },
  "finePrint": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
フィールド
kind
(deprecated)

string

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

object (LocalizedString)

必須。イベントの名前（「LA Dodgers at SF Giants」など）。
eventId

string

イベントの ID。この ID は、アカウント内のすべてのイベントで一意である必要があります。ユーザーが同じイベントのチケットを複数保存している場合に、チケットをグループ化するために使用されます。最大 64 文字を使用できます。

指定すると、正確なグループ化が可能になります。グループ化するつもりのなかったチケットがグループ化されないよう、意図しない設定の競合が発生しないように注意してください。イベントごとに使用するクラスが 1 つのみの場合は、これを classId に設定します（発行者 ID 部分は任意）。

指定しない場合、他のデータを使用してチケットのグループ化が行われます（グループ化が不正確になる可能性があります）。
venue

object (EventVenue)

イベント会場の詳細。
dateTime

object (EventDateTime)

イベントの日時情報。
confirmationCodeLabel

enum (ConfirmationCodeLabel)

カード情報ビューで確認コード値（eventTicketObject.reservationInfo.confirmationCode）に使用するラベル。使用可能な各オプションがローカライズされた文字列にマッピングされるため、ユーザーのロケールに基づいて翻訳が表示されます。

confirmationCodeLabel と customConfirmationCodeLabel の両方は設定できません。いずれも設定されない場合、ラベルはデフォルトでローカライズされた「確認コード」に設定されます。確認コード フィールドが設定されていない場合、このラベルは使用されません。
customConfirmationCodeLabel

object (LocalizedString)

カード情報ビューで確認コード値（eventTicketObject.reservationInfo.confirmationCode）に使用するカスタムラベル。デフォルトの「確認コード」ラベルや confirmationCodeLabel オプションのいずれかでは不十分な場合にのみ使用します。

confirmationCodeLabel と customConfirmationCodeLabel の両方は設定できません。いずれも設定されない場合、ラベルはデフォルトでローカライズされた「確認コード」に設定されます。確認コード フィールドが設定されていない場合、このラベルは使用されません。
seatLabel

enum (SeatLabel)

カード情報ビューで座席値（eventTicketObject.seatInfo.seat）に使用するラベル。使用可能な各オプションがローカライズされた文字列にマッピングされるため、ユーザーのロケールに基づいて翻訳が表示されます。

seatLabel と customSeatLabel の両方は設定できません。いずれも設定されない場合、ラベルはデフォルトでローカライズされた「座席」に設定されます。座席フィールドが設定されていない場合、このラベルは使用されません。
customSeatLabel

object (LocalizedString)

カード情報ビューで座席値（eventTicketObject.seatInfo.seat）に使用するカスタムラベル。デフォルトの「座席」ラベルや seatLabel オプションのいずれかでは不十分な場合にのみ使用します。

seatLabel と customSeatLabel の両方は設定できません。いずれも設定されない場合、ラベルはデフォルトでローカライズされた「座席」に設定されます。座席フィールドが設定されていない場合、このラベルは使用されません。
rowLabel

enum (RowLabel)

カード情報ビューで列値（eventTicketObject.seatInfo.row）に使用するラベル。使用可能な各オプションがローカライズされた文字列にマッピングされるため、ユーザーのロケールに基づいて翻訳が表示されます。

rowLabel と customRowLabel の両方は設定できません。いずれも設定されない場合、ラベルはデフォルトでローカライズされた「列」に設定されます。列フィールドが設定されていない場合、このラベルは使用されません。
customRowLabel

object (LocalizedString)

カード情報ビューで列値（eventTicketObject.seatInfo.row）に使用するカスタムラベル。デフォルトの「列」ラベルや rowLabel オプションのいずれかでは不十分な場合にのみ使用します。

rowLabel と customRowLabel の両方は設定できません。いずれも設定されない場合、ラベルはデフォルトでローカライズされた「列」に設定されます。列フィールドが設定されていない場合、このラベルは使用されません。
sectionLabel

enum (SectionLabel)

カード情報ビューでセクション値（eventTicketObject.seatInfo.section）に使用するラベル。使用可能な各オプションがローカライズされた文字列にマッピングされるため、ユーザーのロケールに基づいて翻訳が表示されます。

sectionLabel と customSectionLabel の両方は設定できません。いずれも設定されない場合、ラベルはデフォルトでローカライズされた「セクション」に設定されます。セクション フィールドが設定されていない場合、このラベルは使用されません。
customSectionLabel

object (LocalizedString)

カード情報ビューでセクション値（eventTicketObject.seatInfo.section）に使用するカスタムラベル。デフォルトの「セクション」ラベルや sectionLabel オプションのいずれかでは不十分な場合にのみ使用します。

sectionLabel と customSectionLabel の両方は設定できません。いずれも設定されない場合、ラベルはデフォルトでローカライズされた「セクション」に設定されます。セクション フィールドが設定されていない場合、このラベルは使用されません。
gateLabel

enum (GateLabel)

カード情報ビューでゲート値（eventTicketObject.seatInfo.gate）に使用するラベル。使用可能な各オプションがローカライズされた文字列にマッピングされるため、ユーザーのロケールに基づいて翻訳が表示されます。

gateLabel と customGateLabel の両方は設定できません。いずれも設定されない場合、ラベルはデフォルトでローカライズされた「ゲート」に設定されます。ゲート フィールドが設定されていない場合、このラベルは使用されません。
customGateLabel

object (LocalizedString)

カード情報ビューでゲート値（eventTicketObject.seatInfo.gate）に使用するカスタムラベル。デフォルトの「ゲート」ラベルや gateLabel オプションのいずれかでは不十分な場合にのみ使用します。

gateLabel と customGateLabel の両方は設定できません。いずれも設定されない場合、ラベルはデフォルトでローカライズされた「ゲート」に設定されます。ゲート フィールドが設定されていない場合、このラベルは使用されません。
finePrint

object (LocalizedString)

チケットの注意事項、利用規約、条件。
classTemplateInfo

object (ClassTemplateInfo)

クラスの表示方法に関するテンプレート情報。設定しない場合、デフォルトの表示フィールドになります。
id

string

必須。クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
version
(deprecated)

string (int64 format)

非推奨
issuerName

string

必須。発行者の名前。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。
messages[]

object (Message)

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

boolean

非推奨です。multipleDevicesAndHoldersAllowedStatus を代わりに使用してください。

homepageUri

object (Uri)

アプリケーションのホームページの URI。このフィールドに URI を指定したときの動作は、linksModuleData に URI を指定したときの動作とまったく同じです（オブジェクトがレンダリングされると、通常はそのオブジェクトの linksModuleData セクションと考えられる場所にホームページのリンクが表示されます）。
locations[]
(deprecated)

object (LatLongPoint)

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

enum (ReviewStatus)

必須。クラスのステータス。このフィールドは、挿入、パッチ、更新の API 呼び出しを使用して draft または underReview に設定できます。レビュー ステータスが draft から変更されると、その後 draft に戻すことはできません。

クラスが開発中の場合は、このフィールドを draft のままにしてください。draft クラスはオブジェクトの作成には使用できません。

クラス使用の準備が整ったら、このフィールドを underReview に設定する必要があります。プラットフォームはこのフィールドを自動的に approved に設定し、オブジェクトの作成と移行にすぐに利用できるようにします。

すでに approved とマークされたクラスを更新する場合、このフィールドを underReview に設定しておく必要があります。
review

object (Review)

クラスが approved または rejected とマークされたときにプラットフォームによって設定されるレビュー コメント。
infoModuleData
(deprecated)

object (InfoModuleData)

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

object (ImageModuleData)

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

object (TextModuleData)

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

string (int64 format)

スマートタップ経由でパスを利用できるクーポン発行者を識別します。クーポン発行者は発行者 ID で識別されます。クーポン発行元には、少なくとも 1 つのスマートタップ キーが設定されている必要があります。

パスがスマートタップをサポートするには、enableSmartTap フィールドとオブジェクト レベルの smartTapRedemptionLevel フィールドも正しく設定する必要があります。
countryCode

string

カードの国を表示するために使用される国コード（ユーザーがその国にいない場合）。あるいは、ユーザーのロケールでコンテンツが利用できない場合にローカライズされたコンテンツを表示するために使用される国コード。
heroImage

object (Image)

カードの表面に表示されるオプションのバナー画像。バナー画像がない場合は、何も表示されません。画像は 100% の幅で表示されます。
wordMark
(deprecated)

object (Image)

サポート終了。
enableSmartTap

boolean

このクラスがスマートタップをサポートしているかどうかを識別します。パスがスマートタップをサポートするには、redemptionIssuers フィールドとオブジェクト レベルの smartTapRedemptionLevel フィールドも正しく設定する必要があります。
hexBackgroundColor

string

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

object (LocalizedString)

issuerName の翻訳文字列。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

複数のユーザーやデバイスについて、このクラスを参照する同じオブジェクトを保存しているかどうかを示します。
callbackOptions

object (CallbackOptions)

コールバック オプション。エンドユーザーがこのクラスのオブジェクトを保存または削除するたびに発行者をコールバックするために使用します。このクラスのすべてのオブジェクトは、コールバックの対象となります。
securityAnimation

object (SecurityAnimation)

セキュリティ アニメーションに関するオプション情報。設定すると、パスの詳細にセキュリティ アニメーションが表示されます。
viewUnlockRequirement

enum (ViewUnlockRequirement)

イベント チケットのロック解除要件のオプションを表示します。
notifyPreference

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

オプションの付加価値モジュール データ。クラスあたりの最大数は 10 です。パスの場合は 10 個のみが表示され、オブジェクトのパスから優先的に表示されます。

EventVenue

JSON 表現 
{
  "kind": string,
  "name": {
    object (LocalizedString)
  },
  "address": {
    object (LocalizedString)
  }
}
フィールド
kind
(deprecated)

string

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

object (LocalizedString)

会場の名前（たとえば、「AT&T Park」）。

必須入力項目です。
address

object (LocalizedString)

会場の住所（たとえば、「24 Willie Mays Plaza\nSan Francisco, CA 94107」）。住所を改行する場合は改行文字（\n）を使用します。

必須入力項目です。

EventDateTime

JSON 表現 
{
  "kind": string,
  "doorsOpen": string,
  "start": string,
  "end": string,
  "doorsOpenLabel": enum (DoorsOpenLabel),
  "customDoorsOpenLabel": {
    object (LocalizedString)
  }
}
フィールド
kind
(deprecated)

string

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

string

開場の日付/時刻。

これは、ISO 8601 拡張形式の日付/時刻です。オフセットを指定することもできます。時刻は、ナノ秒の精度まで指定できます。オフセットは秒の精度で指定できます（オフセット秒は ISO 8601 には含まれていません）。

次に例を示します。

1985-04-12T23:20:50.52Z は、1985 年 4 月 12 日の 23 時 20 分 50.52 秒（UTC）です。

1985-04-12T19:20:50.52-04:00 は、1985 年 4 月 12 日の 19 時 20 分 50.52 秒（UTC の 4 時間前）です（上記の例と同じ時刻を表します）。このイベントがニューヨークで開催されていた場合、これはアメリカ東部夏時間（EDT）に相当します。夏時間を実施しているリージョンでは、年内の時期に応じてオフセットが異なるので注意してください。

1985-04-12T19:20:50.52 は 1985 年 4 月 12 日の 19 時 20 分 50.52 秒で、オフセット情報はありません。

日付 / 時刻の部分にオフセットがない場合、その日付 / 時刻は「ローカルの日付 / 時刻」とみなされます。これは、会場のローカルの日付/時刻である必要があります。たとえば、会場の現地時間で 2018 年 6 月 5 日の 20 時にイベントが開催される場合、ローカルの日付/時刻の部分は 2018-06-05T20:00:00 である必要があります。会場のローカルの日付/時刻が UTC の 4 時間前である場合、オフセット -04:00 を追加できます。

オフセット情報がない場合、高度な機能の一部を使用できないことがあります。
start

string

イベントが開始される日付/時刻。イベントが複数日にわたる場合、これは初日の開始日付/時刻である必要があります。

これは、ISO 8601 拡張形式の日付/時刻です。オフセットを指定することもできます。時刻は、ナノ秒の精度まで指定できます。オフセットは秒の精度で指定できます（オフセット秒は ISO 8601 には含まれていません）。

次に例を示します。

1985-04-12T23:20:50.52Z は、1985 年 4 月 12 日の 23 時 20 分 50.52 秒（UTC）です。

1985-04-12T19:20:50.52-04:00 は、1985 年 4 月 12 日の 19 時 20 分 50.52 秒（UTC の 4 時間前）です（上記の例と同じ時刻を表します）。このイベントがニューヨークで開催されていた場合、これはアメリカ東部夏時間（EDT）に相当します。夏時間を実施しているリージョンでは、年内の時期に応じてオフセットが異なるので注意してください。

1985-04-12T19:20:50.52 は 1985 年 4 月 12 日の 19 時 20 分 50.52 秒で、オフセット情報はありません。

日付 / 時刻の部分にオフセットがない場合、その日付 / 時刻は「ローカルの日付 / 時刻」とみなされます。これは、会場のローカルの日付/時刻である必要があります。たとえば、会場の現地時間で 2018 年 6 月 5 日の 20 時にイベントが開催される場合、ローカルの日付/時刻の部分は 2018-06-05T20:00:00 である必要があります。会場のローカルの日付/時刻が UTC の 4 時間前である場合、オフセット -04:00 を追加できます。

オフセット情報がない場合、高度な機能の一部を使用できないことがあります。
end

string

イベントが終了する日付/時刻。イベントが複数日にわたる場合、これは最終日の終了日付/時刻である必要があります。

これは、ISO 8601 拡張形式の日付/時刻です。オフセットを指定することもできます。時刻は、ナノ秒の精度まで指定できます。オフセットは秒の精度で指定できます（オフセット秒は ISO 8601 には含まれていません）。

次に例を示します。

1985-04-12T23:20:50.52Z は、1985 年 4 月 12 日の 23 時 20 分 50.52 秒（UTC）です。

1985-04-12T19:20:50.52-04:00 は、1985 年 4 月 12 日の 19 時 20 分 50.52 秒（UTC の 4 時間前）です（上記の例と同じ時刻を表します）。このイベントがニューヨークで開催されていた場合、これはアメリカ東部夏時間（EDT）に相当します。夏時間を実施しているリージョンでは、年内の時期に応じてオフセットが異なるので注意してください。

1985-04-12T19:20:50.52 は 1985 年 4 月 12 日の 19 時 20 分 50.52 秒で、オフセット情報はありません。

日付 / 時刻の部分にオフセットがない場合、その日付 / 時刻は「ローカルの日付 / 時刻」とみなされます。これは、会場のローカルの日付/時刻である必要があります。たとえば、会場の現地時間で 2018 年 6 月 5 日の 20 時にイベントが開催される場合、ローカルの日付/時刻の部分は 2018-06-05T20:00:00 である必要があります。会場のローカルの日付/時刻が UTC の 4 時間前である場合、オフセット -04:00 を追加できます。

オフセット情報がない場合、高度な機能の一部を使用できないことがあります。
doorsOpenLabel

enum (DoorsOpenLabel)

カード情報ビューで開場時間値（doorsOpen）に使用するラベル。使用可能な各オプションがローカライズされた文字列にマッピングされるため、ユーザーのロケールに基づいて翻訳が表示されます。

doorsOpenLabel と customDoorsOpenLabel の両方は設定できません。いずれも設定されない場合、ラベルはデフォルトでローカライズされた「開場時間」に設定されます。開場時間フィールドが設定されていない場合、このラベルは使用されません。
customDoorsOpenLabel

object (LocalizedString)

カード情報ビューで開場時間値（doorsOpen）に使用するカスタムラベル。デフォルトの「開場時間」ラベルや doorsOpenLabel オプションのいずれかでは不十分な場合にのみ使用します。

doorsOpenLabel と customDoorsOpenLabel の両方は設定できません。いずれも設定されない場合、ラベルはデフォルトでローカライズされた「開場時間」に設定されます。開場時間フィールドが設定されていない場合、このラベルは使用されません。

DoorsOpenLabel

列挙型
DOORS_OPEN_LABEL_UNSPECIFIED
DOORS_OPEN
doorsOpen

DOORS_OPEN のレガシー エイリアス。サポート終了。
GATES_OPEN
gatesOpen

GATES_OPEN のレガシー エイリアス。サポート終了。

ConfirmationCodeLabel

列挙型
CONFIRMATION_CODE_LABEL_UNSPECIFIED
CONFIRMATION_CODE
confirmationCode

CONFIRMATION_CODE のレガシー エイリアス。サポート終了。
CONFIRMATION_NUMBER
confirmationNumber

CONFIRMATION_NUMBER のレガシー エイリアス。サポート終了。
ORDER_NUMBER
orderNumber

ORDER_NUMBER のレガシー エイリアス。サポート終了。
RESERVATION_NUMBER
reservationNumber

RESERVATION_NUMBER のレガシー エイリアス。サポート終了。

SeatLabel

列挙型
SEAT_LABEL_UNSPECIFIED
SEAT
seat

SEAT のレガシー エイリアス。サポート終了。

RowLabel

列挙型
ROW_LABEL_UNSPECIFIED
ROW
row

ROW のレガシー エイリアス。サポート終了。

SectionLabel

列挙型
SECTION_LABEL_UNSPECIFIED
SECTION
section

SECTION のレガシー エイリアス。サポート終了。
THEATER
theater

THEATER のレガシー エイリアス。サポート終了。

GateLabel

列挙型
GATE_LABEL_UNSPECIFIED
GATE
gate

GATE のレガシー エイリアス。サポート終了。
DOOR
door

DOOR のレガシー エイリアス。サポート終了。
ENTRANCE
entrance

ENTRANCE のレガシー エイリアス。サポート終了。

メソッド

addmessage

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

get

 指定されたクラス ID のイベント チケットクラスを返します。

insert

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

list

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

patch

 指定されたクラス ID のイベント チケットクラスを更新します。

update

 指定されたクラス ID のイベント チケットクラスを更新します。