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)
  }
}
フィールド
kind
(deprecated)

string

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

eventName

object (LocalizedString)

必須。イベントの名前(「LA ドジャース対サンフランシスコ ジャイアンツ」など)。

eventId

string

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

指定すると、グループ化は固定されます。グループ化すべきでないチケットがグループ化されないように、意図しない競合に注意してください。イベントごとに 1 つのクラスのみを使用する場合は、これを classId に設定できます(発行者 ID の部分は任意)。

指定しない場合、プラットフォームは他のデータを使用してチケットのグループ化を試みます(不安定になる可能性があります)。

venue

object (EventVenue)

イベント会場の詳細。

dateTime

object (EventDateTime)

予定の日時の情報。

confirmationCodeLabel

enum (ConfirmationCodeLabel)

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

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

customConfirmationCodeLabel

object (LocalizedString)

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

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

seatLabel

enum (SeatLabel)

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

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

customSeatLabel

object (LocalizedString)

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

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

rowLabel

enum (RowLabel)

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

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

customRowLabel

object (LocalizedString)

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

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

sectionLabel

enum (SectionLabel)

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

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

customSectionLabel

object (LocalizedString)

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

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

gateLabel

enum (GateLabel)

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

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

customGateLabel

object (LocalizedString)

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

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

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)

必須。クラスのステータス。このフィールドは、挿入、パッチ、更新の 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)に使用するラベル。利用可能な各オプションは、ローカライズされた文字列のセットにマッピングされており、ユーザーのロケールに基づいて翻訳が表示されます。

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

customDoorsOpenLabel

object (LocalizedString)

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

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

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 のレガシー エイリアス。廃止されました。

Methods

addmessage

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

get

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

insert

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

list

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

patch

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

update

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