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)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
フィールド
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 つ以上の区間を含めることができます。各区間には出発と到着の情報、搭乗および座席の情報が含まれています。片方区間のみを指定する場合は、代わりに 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 の動作の制限やスクリーンショットの動作などが含まれています。
saveRestrictions

object (SaveRestrictions)

ユーザーがパスの保存を試みる前に確認する必要があるオブジェクトに関する制限。この制限は保存時にのみ適用されます。ユーザーがパスを保存した後に制限が変更された場合、すでに保存されているパスに新しい制限は適用されません。

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)

使用できるルートに関する制限。たとえば、文字列「Reserved CrossCountry trains only」などです。
routeRestrictionsDetails

object (LocalizedString)

上記の routeRestrictions の詳細。
timeRestrictions

object (LocalizedString)

このチケットの利用時間に関する制限。
otherRestrictions

object (LocalizedString)

「ルート」に該当しないその他の規制「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」。特定の ID がない場合は、代わりに 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

NOT_ACTIVATED のレガシー エイリアス。サポート終了。
ACTIVATED 有効
activated

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

DeviceContext

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

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

string

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

メソッド

addmessage

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

get

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

insert

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

list

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

patch

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

update

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