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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
フィールド
kind
(deprecated)

string

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

object (LocalizedString)

必須。イベントの名前（「LA ドジャース対 SF ジャイアンツ」など）。
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[]

object (LatLongPoint)

注: 現在、このフィールドで位置情報通知をトリガーすることはサポートされていません。
reviewStatus

enum (ReviewStatus)

必須。クラスのステータス。このフィールドは、insert、patch、または update 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 です。ここで、rrggbb は 16 進数の RGB トリプレットです（例: #ffcc00）。#fc0 など、RGB トリプレットの省略形も使用できます。rgb
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

セキュリティ アニメーションに関するオプションの情報。これが設定されている場合、パスの詳細にセキュリティ アニメーションがレンダリングされます。
viewUnlockRequirement

enum (ViewUnlockRequirement)

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

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 は UTC で 1985 年 4 月 12 日の 23 時 20 分 50.52 秒になります。

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 は UTC で 1985 年 4 月 12 日の 23 時 20 分 50.52 秒になります。

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 は UTC で 1985 年 4 月 12 日の 23 時 20 分 50.52 秒になります。

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 の両方は設定できません。どちらも設定されていない場合、ラベルはデフォルトでローカライズされた「Doors Open」に設定されます。開場時間が設定されていない場合、このラベルは使用されません。
customDoorsOpenLabel

object (LocalizedString)

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

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

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 のイベント チケットクラスを更新します。