パッケージ google.walletobjects.v1.transit

インデックス

TransitClassService

AddMessage

rpc AddMessage(TransitClassAddMessageRequest) returns (TransitClassAddMessageResponse)

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

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(TransitClassGetRequest) returns (TransitClass)

指定されたクラス ID の交通機関クラスを返します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(TransitClassInsertRequest) returns (TransitClass)

指定された ID とプロパティの交通機関クラスを挿入します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(TransitClassListRequest) returns (TransitClassListResponse)

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

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(TransitClassPatchRequest) returns (TransitClass)

指定されたクラス ID で参照される交通機関クラスを更新します。このメソッドは、パッチのセマンティクスをサポートします。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(TransitClassUpdateRequest) returns (TransitClass)

指定されたクラス ID の交通機関クラスを更新します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer

TransitObjectService

AddMessage

rpc AddMessage(TransitObjectAddMessageRequest) returns (TransitObjectAddMessageResponse)

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

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(TransitObjectGetRequest) returns (TransitObject)

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

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(TransitObjectInsertRequest) returns (TransitObject)

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

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(TransitObjectListRequest) returns (TransitObjectListResponse)

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

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(TransitObjectPatchRequest) returns (TransitObject)

指定されたオブジェクト ID によって参照される交通機関オブジェクトを更新します。このメソッドは、パッチのセマンティクスをサポートします。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(TransitObjectUpdateRequest) returns (TransitObject)

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

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer

PurchaseDetails

フィールド
purchase_receipt_number

string

チケットの販売者を介したチケット購入を追跡するための領収書番号 / ID。

purchase_date_time

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

オフセット情報がない場合、高度な機能の一部を使用できないことがあります。

account_id

string

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

confirmation_code

string

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

ticket_cost

TicketCost

チケットの費用。

TicketCost

フィールド
face_value

Money

チケットの額面金額。

purchase_price

Money

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

discount_message

LocalizedString

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

TicketLeg

フィールド
origin_station_code

string

交通機関の出発地のコード。これは、destinationStationCode が存在する場合、または originName が存在しない場合に必要です。

origin_name

LocalizedString

交通機関の出発地の名前。これは、desinationName が存在する場合、または originStationCode が存在しない場合に必要です。

destination_station_code

string

交通機関の目的地のコード。

destination_name

LocalizedString

目的地の名前。

departure_date_time

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

オフセット情報がない場合、高度な機能の一部を使用できないことがあります。

arrival_date_time

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

オフセット情報がない場合、高度な機能の一部を使用できないことがあります。

fare_name

LocalizedString

この旅行区間の運賃の簡単な説明 / 名前。たとえば、「いつでも 1 回のみ使用」です。

carriage

string

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

platform

string

乗客が乗るために使用するプラットホームまたはゲート。

zone

string

プラットホーム内の乗車位置。

ticket_seat

TicketSeat

乗客の指定席。複数の座席を指定する場合は、代わりに ticketSeats 項目を使用します。ticketSeatticketSeats の両方は設定できません。

ticket_seats[]

TicketSeat

乗客の指定席。座席を 1 つのみ指定する場合は、代わりに ticketSeat 項目を使用します。ticketSeatticketSeats の両方は設定できません。

transit_operator_name

LocalizedString

この旅行区間を運行している交通事業者の名前。

transit_terminus_name

LocalizedString

列車 / バスなどの終点または目的地。

TicketRestrictions

フィールド
route_restrictions

LocalizedString

使用できるルートに関する制限。たとえば、これは「予約済みの CrossCountry 社の列車のみ」という文字列です。

route_restrictions_details

LocalizedString

上記の routeRestrictions に関する詳細。

time_restrictions

LocalizedString

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

other_restrictions

LocalizedString

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

TicketSeat

フィールド
fare_class

FareClass

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

custom_fare_class

LocalizedString

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

coach

string

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

seat

string

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

seat_assignment

LocalizedString

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

FareClass

列挙型
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

ECONOMY のレガシー エイリアス。非推奨。

FIRST
first

FIRST のレガシー エイリアス。非推奨。

BUSINESS
business

BUSINESS のレガシー エイリアス。非推奨。

TransitClass

フィールド
transit_operator_name

LocalizedString

交通事業者の名前。

transit_type

TransitType

必須。このクラスが表す交通機関のタイプ(「バス」など)。

watermark

Image

ユーザーのデバイスに表示する透かし画像。

language_override

string

このフィールドが存在する場合、ユーザーのデバイスに配信される乗車券は常にこの言語で表されます。BCP 47 言語タグを表します。たとえば、「en-US」、「en-GB」、「de」、「de-AT」など。

custom_transit_terminus_name_label

LocalizedString

終点名の値(transitObject.ticketLeg.transitTerminusName)に使用するカスタムラベル。

custom_ticket_number_label

LocalizedString

チケット番号の値(transitObject.ticketNumber)に使用するカスタムラベル。

custom_route_restrictions_label

LocalizedString

利用ルート制限の値(transitObject.ticketRestrictions.routeRestrictions)に使用するカスタムラベル。

custom_route_restrictions_details_label

LocalizedString

利用ルート制限の詳細値(transitObject.ticketRestrictions.routeRestrictionsDetails)に使用するカスタムラベル。

custom_time_restrictions_label

LocalizedString

時間制限の詳細値(transitObject.ticketRestrictions.timeRestrictions)に使用するカスタムラベル。

custom_other_restrictions_label

LocalizedString

他の制限値(transitObject.ticketRestrictions.otherRestrictions)に使用するカスタムラベル。

custom_purchase_receipt_number_label

LocalizedString

購入領収書番号の値(transitObject.purchaseDetails.purchaseReceiptNumber)に使用するカスタムラベル。

custom_confirmation_code_label

LocalizedString

確認コードの値(transitObject.purchaseDetails.confirmationCode)に使用するカスタムラベル。

custom_purchase_face_value_label

LocalizedString

購入額面金額(transitObject.purchaseDetails.ticketCost.faceValue)に使用するカスタムラベル。

custom_purchase_price_label

LocalizedString

購入価格の値(transitObject.purchaseDetails.ticketCost.purchasePrice)に使用するカスタムラベル。

custom_discount_message_label

LocalizedString

交通機関割引メッセージの値(transitObject.purchaseDetails.ticketCost.discountMessage)に使用するカスタムラベル。

custom_carriage_label

LocalizedString

車両の値(transitObject.ticketLeg.carriage)に使用するカスタムラベル。

custom_seat_label

LocalizedString

座席位置の値(transitObject.ticketLeg.ticketSeat.seat)に使用するカスタムラベル。

custom_coach_label

LocalizedString

普通席の値(transitObject.ticketLeg.ticketSeat.coach)に使用するカスタムラベル。

custom_platform_label

LocalizedString

乗車ホームの値(transitObject.ticketLeg.platform)に使用するカスタムラベル。

custom_zone_label

LocalizedString

乗車位置の値(transitObject.ticketLeg.zone)に使用するカスタムラベル。

custom_fare_class_label

LocalizedString

運賃クラスの値(transitObject.ticketLeg.ticketSeat.fareClass)に使用するカスタムラベル。

custom_concession_category_label

LocalizedString

乗車割引カテゴリの値(transitObject.concessionCategory)に使用するカスタムラベル。

custom_fare_name_label

LocalizedString

運賃名の値(transitObject.ticketLeg.fareName)に使用するカスタムラベル。

class_template_info

ClassTemplateInfo

クラスの表示方法に関するテンプレート情報。設定しない場合、デフォルトの表示フィールドになります。

enable_single_leg_itinerary

bool

このクラスの片道旅程の表示を制御します。デフォルトでは、旅程は往復のみ表示されます。

id

string

必須。クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。

version
(deprecated)

int64

非推奨

issuer_name

string

必須。発行者の名前。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。

messages[]

Message

アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。このフィールドの最大数は 10 です。

allow_multiple_users_per_object
(deprecated)

bool

非推奨。代わりに multipleDevicesAndHoldersAllowedStatus を使用してください。

homepage_uri

Uri

アプリケーションのホームページの URI。このフィールドに URI を指定したときの動作は、linksModuleData に URI を指定したときの動作とまったく同じです(オブジェクトがレンダリングされるときに、一般的にオブジェクトの linksModuleData セクションと考えられる場所にホームページのリンクが表示されます)。

locations[]

LatLongPoint

review_status

ReviewStatus

必須。クラスのステータス。挿入、パッチ、更新の API 呼び出しを使用して draft または underReview に設定することもできます。レビュー ステータスが draft から変更されると、その後 draft に戻すことはできません。

クラスが開発中の場合は、この項目を draft のままにしてください。draft クラスはオブジェクトの作成には使用できません。

クラス使用の準備が整ったら、この項目を underReview に設定する必要があります。プラットフォームはこの項目を自動的に approved に設定し、オブジェクトの作成と移行にすぐに利用できるようにします。

既存の approved クラスを更新する場合、このフィールドを引き続き underReview に設定しておく必要があります。

review

Review

クラスが approved または rejected とマークされたときにプラットフォームによって設定されたレビュー コメント。

info_module_data
(deprecated)

InfoModuleData

非推奨。代わりに textModulesData を使用してください。

image_modules_data[]

ImageModuleData

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

text_modules_data[]

TextModuleData

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

redemption_issuers[]

int64

スマートタップ対応のパートナーのみが利用できます。詳細については、サポートにお問い合わせください。

country_code

string

カードの国を表示するために使用される国コード(ユーザーがその国にいない場合)。あるいは、ユーザーのロケールでコンテンツが利用できない場合にローカライズされたコンテンツを表示するために使用される国コード。

hero_image

Image

カードの表面に表示されるオプションのバナー画像。バナー画像がない場合は、何も表示されません。画像は 100% の幅で表示されます。

word_mark
(deprecated)

Image

非推奨。

enable_smart_tap

bool

スマートタップ対応のパートナーのみが利用できます。詳細については、サポートにお問い合わせください。

hex_background_color

string

カードの背景色。設定されていない場合は、ヒーロー画像の主要色が使用され、ヒーロー画像が設定されていない場合は、ロゴの主要色が使用されます。形式は #rrggbb です(#ffcc00 など)。ここで rrggbb は 16 進数の RGB トリプレットです。#fc0 など、RGB トリプレットの省略形 #rgb も使用できます。

localized_issuer_name

LocalizedString

issuer_name の翻訳文字列。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。

multiple_devices_and_holders_allowed_status

MultipleDevicesAndHoldersAllowedStatus

このクラスを参照する同じオブジェクトを保存するユーザーやデバイスが複数かどうかを指定します。

callback_options

CallbackOptions

コールバック オプション。エンドユーザーがこのクラスのオブジェクトを保存または削除するたびに発行者をコールバックするために使用します。このクラスのすべてのオブジェクトは、コールバックの対象となります。

TransitType

列挙型
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

BUS のレガシー エイリアス。非推奨。

RAIL
rail

RAIL のレガシー エイリアス。非推奨。

TRAM
tram

TRAM のレガシー エイリアス。非推奨。

FERRY
ferry

FERRY のレガシー エイリアス。非推奨。

OTHER
other

OTHER のレガシー エイリアス。非推奨。

TransitClassAddMessageRequest

フィールド
resource_id

string

クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。

add_message_request

AddMessageRequest

リクエストの本文。

TransitClassAddMessageResponse

フィールド
resource

TransitClass

更新される TransitClass リソース。

TransitClassGetRequest

フィールド
resource_id

string

クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。

TransitClassInsertRequest

フィールド
resource

TransitClass

リクエストの本文。

TransitClassListRequest

フィールド
issuer_id

int64

クラスをリストする権限を持つ発行者の ID。

token

string

maxResults が指定されているが、maxResults より多数のクラスがリストに含まれる場合に、次の結果を取得するために使用します。たとえば、200 個のクラスを含むリストがあり、maxResults を 20 に設定してリストを呼び出した場合、リストからは最初の 20 個のクラスとトークンが返されます。次の 20 個のクラスを取得するには、20 に設定した maxResults とこのトークンを指定して、再度リストを呼び出します。

max_results

int32

リストから返される結果の最大数を示します。maxResults が定義されない場合は、すべての結果が返されます。

TransitClassListResponse

フィールド
resources[]

TransitClass

リスト リクエストに対応するリソース。

pagination

Pagination

レスポンスのページ分け。

TransitClassPatchRequest

フィールド
resource_id

string

クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。

resource

TransitClass

リクエストの本文。

TransitClassUpdateRequest

フィールド
resource_id

string

クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。

resource

TransitClass

リクエストの本文。

TransitObject

フィールド
class_reference

TransitClass

親クラスの継承された項目のコピー。この項目は、GET 中に取得されます。

ticket_number

string

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

passenger_type

PassengerType

乗客の数。

passenger_names

string

チケットが割り当てられている乗客の名前。上記の passengerType 項目は、この項目に Google のコンテキストを与えるためのものです。

trip_id

string

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

ticket_status

TicketStatus

チケットのステータス。表示に影響する状態については、代わりに state 項目を使用します。

custom_ticket_status

LocalizedString

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

concession_category

ConcessionCategory

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

custom_concession_category

LocalizedString

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

ticket_restrictions

TicketRestrictions

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

purchase_details

PurchaseDetails

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

ticket_leg

TicketLeg

1 つのチケット区間に発着情報と搭乗および座席の情報が含まれています。複数の区間を指定する場合は、代わりに ticketLegs 項目を使用します。ticketLegticketLegs の両方は設定できません。

ticket_legs[]

TicketLeg

各チケットに 1 つ以上の区間が含まれています。各区間に発着情報と搭乗および座席の情報が含まれています。1 つの区間のみを指定する場合は、代わりに ticketLeg 項目を使用します。ticketLegticketLegs の両方は設定できません。

hex_background_color

string

カードの背景色。設定されていない場合は、ヒーロー画像の主要色が使用され、ヒーロー画像が設定されていない場合は、ロゴの主要色が使用されます。形式は #rrggbb です(#ffcc00 など)。ここで rrggbb は 16 進数の RGB トリプレットです。#fc0 など、RGB トリプレットの省略形 #rgb も使用できます。

trip_type

TripType

必須。この交通機関オブジェクトが表す旅行のタイプ。出発地と目的地の間で使用するマークを決定するために使用されます。

id

string

必須。オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。

class_id

string

必須。このオブジェクトに関連付けられたクラス。クラスはこのオブジェクトと同じ型で、すでに存在し、承認される必要があります。

クラス ID には、issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。

version
(deprecated)

int64

非推奨

state

State

必須。オブジェクトの状態。このフィールドは、アプリでのオブジェクトの表示方法を決定するために使用されます。たとえば、inactive オブジェクトを「期限切れのパス」セクションに移動する場合に使用します。

barcode

Barcode

バーコードのタイプと値。

messages[]

Message

アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。このフィールドの最大数は 10 です。

valid_time_interval

TimeInterval

このオブジェクトが active になり、オブジェクトが使用可能である期間。この期間が経過すると、オブジェクトの状態は expired に変更されます。

locations[]

LatLongPoint

オブジェクトを使用できる場所のリスト。この情報は、位置情報の通知をトリガーするために使用されます。オブジェクト内の場所、クラス内の場所、Google プレイス ID の場所の順に優先されます。

has_users

bool

オブジェクトにユーザーが存在するかどうかを示します。このフィールドはプラットフォームによって設定されます。

smart_tap_redemption_value

string

スマートタップ対応のパートナーのみが利用できます。詳細については、サポートにお問い合わせください。

has_linked_device

bool

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

disable_expiration_notification

bool

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

現在、これはクーポンにのみ設定できます。

info_module_data

InfoModuleData

非推奨。代わりに textModulesData を使用してください。

image_modules_data[]

ImageModuleData

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

text_modules_data[]

TextModuleData

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

ConcessionCategory

列挙型
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

ADULT のレガシー エイリアス。非推奨。

CHILD
child

CHILD のレガシー エイリアス。非推奨。

SENIOR
senior

SENIOR のレガシー エイリアス。非推奨。

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 のレガシー エイリアス。非推奨。

TripType

列挙型
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

ROUND_TRIP のレガシー エイリアス。非推奨。

ONE_WAY
oneWay

ONE_WAY のレガシー エイリアス。非推奨。

TransitObjectAddMessageRequest

フィールド
resource_id

string

オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。

add_message_request

AddMessageRequest

リクエストの本文。

TransitObjectAddMessageResponse

フィールド
resource

TransitObject

更新される TransitObject リソース。

TransitObjectGetRequest

フィールド
resource_id

string

オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。

TransitObjectInsertRequest

フィールド
resource

TransitObject

リクエストの本文。

TransitObjectListRequest

フィールド
class_id

string

オブジェクトがリストされるクラスの ID。

token

string

maxResults が指定されているが、maxResults より多数のオブジェクトがリストに含まれる場合に、次の結果を取得するために使用します。たとえば、200 個のオブジェクトを含むリストがあり、maxResults を 20 に設定してリストを呼び出した場合、リストからは最初の 20 個のオブジェクトとトークンが返されます。次の 20 個のオブジェクトを取得するには、20 に設定した maxResults とこのトークンを指定して、再度リストを呼び出します。

max_results

int32

リストから返される結果の最大数を示します。maxResults が定義されない場合は、すべての結果が返されます。

TransitObjectListResponse

フィールド
resources[]

TransitObject

リスト リクエストに対応するリソース。

pagination

Pagination

レスポンスのページ分け。

TransitObjectPatchRequest

フィールド
resource_id

string

オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。

resource

TransitObject

リクエストの本文。

TransitObjectUpdateRequest

フィールド
resource_id

string

オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。

resource

TransitObject

リクエストの本文。