REST Resource: transitobject

リソース: TransitObject

JSON 表現 
{
  "classReference": {
    object (TransitClass)
  },
  "ticketNumber": string,
  "passengerType": enum (PassengerType),
  "passengerNames": string,
  "tripId": string,
  "ticketStatus": enum (TicketStatus),
  "customTicketStatus": {
    object (LocalizedString)
  },
  "concessionCategory": enum (ConcessionCategory),
  "customConcessionCategory": {
    object (LocalizedString)
  },
  "ticketRestrictions": {
    object (TicketRestrictions)
  },
  "purchaseDetails": {
    object (PurchaseDetails)
  },
  "ticketLeg": {
    object (TicketLeg)
  },
  "ticketLegs": [
    {
      object (TicketLeg)
    }
  ],
  "hexBackgroundColor": string,
  "tripType": enum (TripType),
  "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)
  },
  "activationStatus": {
    object (ActivationStatus)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "deviceContext": {
    object (DeviceContext)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  }
}
フィールド
classReference

object (TransitClass)

親クラスの継承されたフィールドのコピー。これらのフィールドは GET 中に取得されます。
ticketNumber

string

チケットの番号。これは、交通機関のシステムでチケットの一意の識別子です。
passengerType

enum (PassengerType)

乗客の人数。
passengerNames

string

チケットが割り当てられている乗客の名前。上記の passengerType フィールドは、このフィールドに関する Google のコンテキストを提供するためのものです。
tripId

string

この ID は、ユーザーが同じルートの複数のチケットを保存した場合に、チケットをグループ化するために使用されます。
ticketStatus

enum (TicketStatus)

チケットのステータス。表示に影響する状態には、代わりに state フィールドを使用します。
customTicketStatus

object (LocalizedString)

ticketStatus に適切なオプションがない場合に、チケット ステータスの値に使用するカスタム ステータス。ticketStatus と customTicketStatus の両方は設定できません。
concessionCategory

enum (ConcessionCategory)

チケットの割引カテゴリ。
customConcessionCategory

object (LocalizedString)

concessionCategory に適切なオプションがない場合に使用するカスタム割引カテゴリ。concessionCategory と customConcessionCategory の両方は設定できません。
ticketRestrictions

object (TicketRestrictions)

このチケットの使用に関する制限の種類に関する情報。たとえば、使用する必要がある曜日や、使用できるルートなどです。
purchaseDetails

object (PurchaseDetails)

このチケットの購入の詳細。
ticketLeg

object (TicketLeg)

1 つのチケット区間に、出発と到着の情報、搭乗と座席の情報が含まれています。複数の区間を指定する場合は、代わりに ticketLegs フィールドを使用します。ticketLeg と ticketLegs の両方は設定できません。
ticketLegs[]

object (TicketLeg)

各チケットには 1 つ以上の区間を含めることができます。各区間には出発と到着の情報、搭乗と座席の情報が含まれています。区間を 1 つだけ指定する場合は、代わりに ticketLeg フィールドを使用します。ticketLeg と ticketLegs の両方は設定できません。
hexBackgroundColor

string

カードの背景色。設定しない場合、ヒーロー画像のドミナント カラーが使用されます。ヒーロー画像が設定されていない場合は、ロゴのドミナント カラーが使用されます。形式は #rrggbb です。ここで、rrggbb は 16 進数の RGB トリプレットです（例: #ffcc00）。#fc0 など、RGB トリプレットの省略形（#rgb）を使用することもできます。
tripType

enum (TripType)

必須。この交通機関オブジェクトが表すルートのタイプ。パスのタイトルや、出発地と目的地の間で使用する記号を決定するために使用されます。
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 経由でスマートタップ認定端末に送信される値。パスでスマートタップをサポートするには、クラスレベルのフィールド enableSmartTap と redemptionIssuers も正しく設定する必要があります。ASCII 文字のみがサポートされています。
hasLinkedDevice

boolean

このオブジェクトが現在 1 つのデバイスにリンクされているかどうか。このフィールドは、ユーザーがオブジェクトを保存してデバイスにリンクしたときに、プラットフォームによって設定されます。一部のパートナー様による使用を想定しています。詳しくはサポートにお問い合わせください。
disableExpirationNotification

boolean

通知を明示的に抑制するかどうかを示します。このフィールドを true に設定すると、messages フィールドに関係なく、ユーザーへの有効期限通知が抑制されます。デフォルトでは、このフィールドは false に設定されています。

現在、これはオファーに対してのみ設定できます。
infoModuleData

object (InfoModuleData)

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

object (ImageModuleData)

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

object (TextModuleData)

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

object (ActivationStatus)

オブジェクトの有効化ステータス。クラスに activationOptions が設定されている場合は必須です。
rotatingBarcode

object (RotatingBarcode)

ローテーション バーコードのタイプと値。
deviceContext

object (DeviceContext)

オブジェクトに関連付けられているデバイスのコンテキスト。
heroImage

object (Image)

カードの表面に表示されるオプションのバナー画像。クラスのヒーロー画像が存在しない場合は、表示されます（存在する場合）。クラスのヒーロー画像も存在しない場合は、何も表示されません。
groupingInfo

object (GroupingInfo)

パスのグループ化に関する情報。
passConstraints

object (PassConstraints)

オブジェクトの制約を渡します。NFC とスクリーンショットの動作の制限も含まれます。

PassengerType

列挙型
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

SINGLE_PASSENGER のレガシー エイリアス。廃止されました。
MULTIPLE_PASSENGERS
multiplePassengers

MULTIPLE_PASSENGERS のレガシー エイリアス。廃止されました。

TicketStatus

列挙型
TICKET_STATUS_UNSPECIFIED
USED
used

USED のレガシー エイリアス。廃止されました。
REFUNDED
refunded

REFUNDED のレガシー エイリアス。廃止されました。
EXCHANGED
exchanged

EXCHANGED のレガシー エイリアス。廃止されました。

ConcessionCategory

列挙型
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

ADULT のレガシー エイリアス。廃止されました。
CHILD
child

CHILD のレガシー エイリアス。廃止されました。
SENIOR
senior

SENIOR のレガシー エイリアス。廃止されました。

TicketRestrictions

JSON 表現 
{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
フィールド
routeRestrictions

object (LocalizedString)

利用できるルートに関する制限。たとえば、「CrossCountry 列車のみの予約」などです。
routeRestrictionsDetails

object (LocalizedString)

上記の routeRestrictions の詳細。
timeRestrictions

object (LocalizedString)

このチケットを使用できる時間に関する制限。
otherRestrictions

object (LocalizedString)

「route」と「time」のカテゴリに該当しないその他の制限。

PurchaseDetails

JSON 表現 
{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}
フィールド
purchaseReceiptNumber

string

チケット販売機関を通じてチケット購入を追跡するための領収書番号/ID。
purchaseDateTime

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 秒で、オフセット情報はありません。

オフセット情報がないと、一部のリッチ機能が利用できない可能性があります。
accountId

string

チケットの購入に使用されたアカウントの ID。
confirmationCode

string

購入の確認コード。複数の異なるチケットで同じ場合があり、チケットをグループ化するために使用されます。
ticketCost

object (TicketCost)

チケットの価格。

TicketCost

JSON 表現 
{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
フィールド
faceValue

object (Money)

チケットの額面価格。
purchasePrice

object (Money)

税金や割引を適用した後のチケットの実際の購入価格。
discountMessage

object (LocalizedString)

適用されたあらゆる種類の割引を説明するメッセージ。

TicketLeg

JSON 表現 
{
  "originStationCode": string,
  "originName": {
    object (LocalizedString)
  },
  "destinationStationCode": string,
  "destinationName": {
    object (LocalizedString)
  },
  "departureDateTime": string,
  "arrivalDateTime": string,
  "fareName": {
    object (LocalizedString)
  },
  "carriage": string,
  "platform": string,
  "zone": string,
  "ticketSeat": {
    object (TicketSeat)
  },
  "ticketSeats": [
    {
      object (TicketSeat)
    }
  ],
  "transitOperatorName": {
    object (LocalizedString)
  },
  "transitTerminusName": {
    object (LocalizedString)
  }
}
フィールド
originStationCode

string

出発地の駅のコード。destinationStationCode が存在する場合、または originName が存在しない場合は必須です。
originName

object (LocalizedString)

出発地の駅の名前。desinationName が存在する場合、または originStationCode が存在しない場合は必須です。
destinationStationCode

string

行き先の駅コード。
destinationName

object (LocalizedString)

目的地の名前。
departureDateTime

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 を追加できます。

オフセット情報がないと、一部のリッチ機能が利用できない可能性があります。
arrivalDateTime

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 を追加できます。

オフセット情報がないと、一部のリッチ機能が利用できない可能性があります。
fareName

object (LocalizedString)

この区間の運賃の簡単な説明または名前。例: 「いつでも 1 回限り」。
carriage

string

乗客が乗車する必要がある列車または船の名前/番号。
platform

string

乗客が乗車できるプラットホームまたはゲート。
zone

string

プラットホーム内の乗車エリアです。
ticketSeat

object (TicketSeat)

乗客の予約席。複数の座席を指定する場合は、代わりに ticketSeats フィールドを使用します。ticketSeat と ticketSeats の両方は設定できません。
ticketSeats[]

object (TicketSeat)

乗客の予約席。座席を 1 つのみ指定する場合は、代わりに ticketSeat フィールドを使用します。ticketSeat と ticketSeats の両方は設定できません。
transitOperatorName

object (LocalizedString)

ルートのこの区間を運営する交通機関の名前。
transitTerminusName

object (LocalizedString)

電車 / バスなどの終着駅または目的地

TicketSeat

JSON 表現 
{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}
フィールド
fareClass

enum (FareClass)

指定された座席の運賃クラス。
customFareClass

object (LocalizedString)

fareClass が該当しない場合に使用するカスタム運賃クラス。fareClass と customFareClass の両方は設定できません。
coach

string

指定された座席がある車両の識別子。例: 「10」
seat

string

指定された座席がある場所の識別子。例: 「42」。特定の識別子がない場合は、代わりに seatAssigment を使用します。
seatAssignment

object (LocalizedString)

乗客の座席の割り当て。例: 「特定の座席なし」seat で使用する特定の識別子がない場合に使用します。

FareClass

列挙型
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

ECONOMY のレガシー エイリアス。廃止されました。
FIRST
first

FIRST のレガシー エイリアス。廃止されました。
BUSINESS
business

BUSINESS のレガシー エイリアス。廃止されました。

TripType

列挙型
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

ROUND_TRIP のレガシー エイリアス。廃止されました。
ONE_WAY
oneWay

ONE_WAY のレガシー エイリアス。廃止されました。

ActivationStatus

オブジェクトの有効化ステータス。このフィールドには、有効化がサポートされている場合、有効化のステータスが含まれます。

JSON 表現 
{
  "state": enum (State)
}
フィールド
state

enum (State)

状態

列挙型
UNKNOWN_STATE
NOT_ACTIVATED 未有効化。これはデフォルトのステータスです。
not_activated

NOT_ACTIVATED のレガシー エイリアス。廃止されました。
ACTIVATED 有効
activated

ACTIVATED のレガシー エイリアス。廃止されました。

DeviceContext

オブジェクトに関連付けられているデバイスのコンテキスト。

JSON 表現 
{
  "deviceToken": string
}
フィールド
deviceToken

string

設定すると、オブジェクトが有効になったときに、クーポン情報が所定のデバイスにのみ返されます。ユーザーのデバイスをトレースするための安定した識別子としては使用しないでください。デバイスが同じでもパスが異なる場合や、デバイスが同じでも有効化が異なる場合は、設定が変わることがあります。これを設定する場合、呼び出し元は、有効にするオブジェクトに hasLinkedDevice を設定する必要があります。

Methods

addmessage

 指定されたオブジェクト ID の交通機関オブジェクトにメッセージを追加します。

get

 指定されたオブジェクト ID の交通機関オブジェクトを返します。

insert

 指定された ID とプロパティの交通機関オブジェクトを挿入します。

list

 指定された発行者 ID のすべての交通機関オブジェクトのリストを返します。

patch

 指定されたオブジェクト ID の交通機関オブジェクトを更新します。

update

 指定されたオブジェクト ID の交通機関オブジェクトを更新します。