- リソース: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus(有効化ステータス)
- 州名
- DeviceContext
- メソッド
リソース: TransitObject
JSON 表現 |
---|
{ "classReference": { object ( |
フィールド | |
---|---|
classReference |
親クラスの継承されたフィールドのコピー。これらのフィールドは GET 中に取得されます。 |
ticketNumber |
チケットの番号。これは、交通機関のシステムでチケットの一意の識別子です。 |
passengerType |
乗客の人数。 |
passengerNames |
チケットが割り当てられている乗客の名前。上記の |
tripId |
この ID は、ユーザーが同じルートの複数のチケットを保存した場合に、チケットをグループ化するために使用されます。 |
ticketStatus |
チケットのステータス。表示に影響する状態には、代わりに |
customTicketStatus |
|
concessionCategory |
チケットの割引カテゴリ。 |
customConcessionCategory |
|
ticketRestrictions |
このチケットの使用に関する制限の種類に関する情報。たとえば、使用する必要がある曜日や、使用できるルートなどです。 |
purchaseDetails |
このチケットの購入の詳細。 |
ticketLeg |
1 つのチケット区間に、出発と到着の情報、搭乗と座席の情報が含まれています。複数の区間を指定する場合は、代わりに |
ticketLegs[] |
各チケットには 1 つ以上の区間を含めることができます。各区間には出発と到着の情報、搭乗と座席の情報が含まれています。区間を 1 つだけ指定する場合は、代わりに |
hexBackgroundColor |
カードの背景色。設定しない場合、ヒーロー画像のドミナント カラーが使用されます。ヒーロー画像が設定されていない場合は、ロゴのドミナント カラーが使用されます。形式は #rrggbb です。ここで、rrggbb は 16 進数の RGB トリプレットです(例: |
tripType |
必須。この交通機関オブジェクトが表すルートのタイプ。パスのタイトルや、出発地と目的地の間で使用する記号を決定するために使用されます。 |
id |
必須。オブジェクトの一意の識別子。この ID は、発行者のすべてのオブジェクトで一意である必要があります。この値は issuer ID の形式にする必要があります。identifier: 前者は Google が発行し、後者はユーザーが選択したものです。一意の識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
classId |
必須。このオブジェクトに関連付けられたクラス。クラスは、このオブジェクトと同じ型で、すでに存在し、承認されている必要があります。 クラス ID は issuer ID の形式にする必要があります。identifier: 前者は Google が発行し、後者はユーザーが選択したものです。 |
version |
非推奨 |
state |
必須。オブジェクトの状態。このフィールドは、アプリでのオブジェクトの表示方法を決定するために使用されます。たとえば、 |
barcode |
バーコードのタイプと値。 |
messages[] |
アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。これらのフィールドの最大数は 10 です。 |
validTimeInterval |
このオブジェクトが |
locations[] |
注: 現在、このフィールドは位置情報に関する通知のトリガーに対応していません。 |
hasUsers |
オブジェクトにユーザーがいるかどうかを示します。このフィールドはプラットフォームによって設定されます。 |
smartTapRedemptionValue |
このオブジェクトについて、NFC 経由でスマートタップ認定端末に送信される値。パスでスマートタップをサポートするには、クラスレベルのフィールド |
hasLinkedDevice |
このオブジェクトが現在 1 つのデバイスにリンクされているかどうか。このフィールドは、ユーザーがオブジェクトを保存してデバイスにリンクしたときに、プラットフォームによって設定されます。一部のパートナー様による使用を想定しています。詳しくはサポートにお問い合わせください。 |
disableExpirationNotification |
通知を明示的に抑制するかどうかを示します。このフィールドを true に設定すると、 現在、これはオファーに対してのみ設定できます。 |
infoModuleData |
非推奨です。代わりに textModulesData を使用してください。 |
imageModulesData[] |
画像モジュールのデータ。表示されるこれらのフィールドの最大数は、オブジェクト レベルで 1 個、クラス オブジェクト レベルで 1 個です。 |
textModulesData[] |
テキスト モジュールのデータ。テキスト モジュール データもクラスで定義されている場合は、両方が表示されます。表示されるこれらのフィールドの最大数は、オブジェクトから 10 個、クラスから 10 個です。 |
linksModuleData |
リンク モジュールのデータ。リンク モジュールのデータもクラスで定義されている場合は、両方が表示されます。 |
appLinkData |
パスの前面にボタンとして表示される、省略可能なアプリまたはウェブサイトのリンク。対応するクラスに AppLinkData が指定されている場合は、AppLinkData オブジェクトのみが表示されます。 |
activationStatus |
オブジェクトの有効化ステータス。クラスに |
rotatingBarcode |
ローテーション バーコードのタイプと値。 |
deviceContext |
オブジェクトに関連付けられているデバイスのコンテキスト。 |
heroImage |
カードの表面に表示されるオプションのバナー画像。クラスのヒーロー画像が存在しない場合は、表示されます(存在する場合)。クラスのヒーロー画像も存在しない場合は、何も表示されません。 |
groupingInfo |
パスのグループ化に関する情報。 |
passConstraints |
オブジェクトの制約を渡します。NFC とスクリーンショットの動作の制限も含まれます。 |
PassengerType
列挙型 | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
|
MULTIPLE_PASSENGERS |
|
multiplePassengers |
|
TicketStatus
列挙型 | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
|
REFUNDED |
|
refunded |
|
EXCHANGED |
|
exchanged |
|
ConcessionCategory
列挙型 | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
|
CHILD |
|
child |
|
SENIOR |
|
senior |
|
TicketRestrictions
JSON 表現 |
---|
{ "routeRestrictions": { object ( |
フィールド | |
---|---|
routeRestrictions |
利用できるルートに関する制限。たとえば、「CrossCountry 列車のみの予約」などです。 |
routeRestrictionsDetails |
上記の |
timeRestrictions |
このチケットを使用できる時間に関する制限。 |
otherRestrictions |
「route」と「time」のカテゴリに該当しないその他の制限。 |
PurchaseDetails
JSON 表現 |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
フィールド | |
---|---|
purchaseReceiptNumber |
チケット販売機関を通じてチケット購入を追跡するための領収書番号/ID。 |
purchaseDateTime |
チケットの購入日時。 これは ISO 8601 拡張形式の日付/時刻です。オフセットは設定しなくても構いません。時刻はナノ秒の精度まで指定できます。オフセットは秒の精度で指定できます(オフセット秒は ISO 8601 には含まれていません)。 次に例を示します。
オフセット情報がないと、一部のリッチ機能が利用できない可能性があります。 |
accountId |
チケットの購入に使用されたアカウントの ID。 |
confirmationCode |
購入の確認コード。複数の異なるチケットで同じ場合があり、チケットをグループ化するために使用されます。 |
ticketCost |
チケットの価格。 |
TicketCost
JSON 表現 |
---|
{ "faceValue": { object ( |
フィールド | |
---|---|
faceValue |
チケットの額面価格。 |
purchasePrice |
税金や割引を適用した後のチケットの実際の購入価格。 |
discountMessage |
適用されたあらゆる種類の割引を説明するメッセージ。 |
TicketLeg
JSON 表現 |
---|
{ "originStationCode": string, "originName": { object ( |
フィールド | |
---|---|
originStationCode |
出発地の駅のコード。 |
originName |
出発地の駅の名前。 |
destinationStationCode |
行き先の駅コード。 |
destinationName |
目的地の名前。 |
departureDateTime |
出発日時。交通機関のオブジェクトに有効期間が設定されていない場合は必須です。 これは ISO 8601 拡張形式の日付/時刻です。オフセットは設定しなくても構いません。時刻はナノ秒の精度まで指定できます。オフセットは秒の精度で指定できます(オフセット秒は ISO 8601 には含まれていません)。 次に例を示します。
オフセットのない日付/時刻の部分は「ローカルの日付/時刻」とみなされます。出発地のローカルの日付/時刻にする必要があります。たとえば、出発地で 2018 年 6 月 5 日の 20 時に出発の場合、ローカルの日付/時刻部分は オフセット情報がないと、一部のリッチ機能が利用できない可能性があります。 |
arrivalDateTime |
到着日時。 これは ISO 8601 拡張形式の日付/時刻です。オフセットは設定しなくても構いません。時刻はナノ秒の精度まで指定できます。オフセットは秒の精度で指定できます(オフセット秒は ISO 8601 には含まれていません)。 次に例を示します。
オフセットのない日付/時刻の部分は「ローカルの日付/時刻」とみなされます。これは、到着地のローカルの日付/時刻である必要があります。たとえば、到着地でイベントが 2018 年 6 月 5 日の 20 時に発生する場合、ローカルの日付/時刻部分は オフセット情報がないと、一部のリッチ機能が利用できない可能性があります。 |
fareName |
この区間の運賃の簡単な説明または名前。例: 「いつでも 1 回限り」。 |
carriage |
乗客が乗車する必要がある列車または船の名前/番号。 |
platform |
乗客が乗車できるプラットホームまたはゲート。 |
zone |
プラットホーム内の乗車エリアです。 |
ticketSeat |
乗客の予約席。複数の座席を指定する場合は、代わりに |
ticketSeats[] |
乗客の予約席。座席を 1 つのみ指定する場合は、代わりに |
transitOperatorName |
ルートのこの区間を運営する交通機関の名前。 |
transitTerminusName |
電車 / バスなどの終着駅または目的地 |
TicketSeat
JSON 表現 |
---|
{ "fareClass": enum ( |
フィールド | |
---|---|
fareClass |
指定された座席の運賃クラス。 |
customFareClass |
|
coach |
指定された座席がある車両の識別子。例: 「10」 |
seat |
指定された座席がある場所の識別子。例: 「42」。特定の識別子がない場合は、代わりに |
seatAssignment |
乗客の座席の割り当て。例: 「特定の座席なし」 |
FareClass
列挙型 | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
|
FIRST |
|
first |
|
BUSINESS |
|
business |
|
TripType
列挙型 | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
|
ONE_WAY |
|
oneWay |
|
ActivationStatus
オブジェクトの有効化ステータス。このフィールドには、有効化がサポートされている場合、有効化のステータスが含まれます。
JSON 表現 |
---|
{
"state": enum ( |
フィールド | |
---|---|
state |
|
状態
列挙型 | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
未有効化。これはデフォルトのステータスです。 |
not_activated |
|
ACTIVATED |
有効 |
activated |
|
DeviceContext
オブジェクトに関連付けられているデバイスのコンテキスト。
JSON 表現 |
---|
{ "deviceToken": string } |
フィールド | |
---|---|
deviceToken |
設定すると、オブジェクトが有効になったときに、クーポン情報が所定のデバイスにのみ返されます。ユーザーのデバイスをトレースするための安定した識別子としては使用しないでください。デバイスが同じでもパスが異なる場合や、デバイスが同じでも有効化が異なる場合は、設定が変わることがあります。これを設定する場合、呼び出し元は、有効にするオブジェクトに hasLinkedDevice を設定する必要があります。 |
メソッド |
|
---|---|
|
指定されたオブジェクト ID の交通機関オブジェクトにメッセージを追加します。 |
|
指定されたオブジェクト ID の交通機関オブジェクトを返します。 |
|
指定された ID とプロパティの交通機関オブジェクトを挿入します。 |
|
指定された発行者 ID のすべての交通機関オブジェクトのリストを返します。 |
|
指定されたオブジェクト ID の交通機関オブジェクトを更新します。 |
|
指定されたオブジェクト ID の交通機関オブジェクトを更新します。 |