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)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
フィールド
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 です（#ffcc00 など）。rrggbb は 16 進数の RGB トリプレットです。#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[]
(deprecated)

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)

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

string

linkedObjectIds は、この交通機関オブジェクトに自動的に関連付けられる他のオブジェクト（イベント チケット、ポイントカード、クーポン、汎用、ギフトカード、交通機関、搭乗券など）のリストです。ユーザーがこの交通機関のカードを保存していた場合、これらの linkedObjectId は、（ユーザーがそのようなリンクされたパスを受け取る設定をオフにしていない限り）ユーザーのウォレットに自動的にプッシュされます。

linkedObjectIds に存在するオブジェクトがすでに挿入されていることを確認します。挿入されていない場合、呼び出しは失敗します。リンクしたオブジェクトのリンクを解除することはできません。別のカード発行会社に属するオブジェクトをリンクすることはできません。1 つのオブジェクトにリンクできるオブジェクトの数には上限があります。上限に達すると、呼び出し内の新しいリンク済みオブジェクトは無視されます。

オブジェクト ID は issuer ID 形式にする必要があります。identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。
notifyPreference

enum (NotificationSettingsForUpdates)

このオブジェクトのフィールドの更新が通知をトリガーするかどうか。NOTIFY に設定すると、フィールドの更新通知がユーザーに送信されます。これらの通知は、フィールドが許可リストに含まれている場合にのみユーザーに送信されます。DO_NOT_NOTIFY または NOTIFICATION_SETTINGS_UNSPECIFIED に設定した場合、通知はトリガーされません。この設定は一時的な設定であり、PATCH リクエストまたは UPDATE リクエストごとに設定する必要があります。設定しない場合、通知はトリガーされません。
valueAddedModuleData[]

object (ValueAddedModuleData)

オプションの付加価値モジュール データ。オブジェクトに最大 10 個。

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)

「ルート」または「時間」カテゴリに該当しないその他の制限。

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 は、1985 年 4 月 12 日の 23 時 20 分 50.52 秒（UTC）です。

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 は、1985 年 4 月 12 日の 23 時 20 分 50.52 秒（UTC）です。

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 は、1985 年 4 月 12 日の 23 時 20 分 50.52 秒（UTC）です。

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 に使用する特定の ID がない場合に使用します。

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 も設定する必要があります。

メソッド

addmessage

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

get

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

insert

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

list

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

patch

 指定されたオブジェクト ID によって参照される交通機関オブジェクトを更新します。

update

 指定されたオブジェクト ID によって参照される交通機関オブジェクトを更新します。