インデックス
TransitClassService
(インターフェース)TransitObjectService
(インターフェース)PurchaseDetails
(メッセージ)TicketCost
(メッセージ)TicketLeg
(メッセージ)TicketRestrictions
(メッセージ)TicketSeat
(メッセージ)TicketSeat.FareClass
(列挙型)TransitClass
(メッセージ)TransitClass.TransitType
(列挙型)TransitClassAddMessageRequest
(メッセージ)TransitClassAddMessageResponse
(メッセージ)TransitClassGetRequest
(メッセージ)TransitClassInsertRequest
(メッセージ)TransitClassListRequest
(メッセージ)TransitClassListResponse
(メッセージ)TransitClassPatchRequest
(メッセージ)TransitClassUpdateRequest
(メッセージ)TransitObject
(メッセージ)TransitObject.ConcessionCategory
(列挙型)TransitObject.PassengerType
(列挙型)TransitObject.TicketStatus
(列挙型)TransitObject.TripType
(列挙型)TransitObjectAddMessageRequest
(メッセージ)TransitObjectAddMessageResponse
(メッセージ)TransitObjectGetRequest
(メッセージ)TransitObjectInsertRequest
(メッセージ)TransitObjectListRequest
(メッセージ)TransitObjectListResponse
(メッセージ)TransitObjectPatchRequest
(メッセージ)TransitObjectUpdateRequest
(メッセージ)
TransitClassService
AddMessage | |
---|---|
指定されたクラス ID の交通機関クラスにメッセージを追加します。
|
Get | |
---|---|
指定されたクラス ID の交通機関クラスを返します。
|
Insert | |
---|---|
指定された ID とプロパティの交通機関クラスを挿入します。
|
List | |
---|---|
指定された発行者 ID のすべての交通機関クラスのリストを返します。
|
Patch | |
---|---|
指定されたクラス ID で参照される交通機関クラスを更新します。このメソッドは、パッチのセマンティクスをサポートします。
|
Update | |
---|---|
指定されたクラス ID の交通機関クラスを更新します。
|
TransitObjectService
AddMessage | |
---|---|
指定されたオブジェクト ID の交通機関オブジェクトにメッセージを追加します。
|
Get | |
---|---|
指定されたオブジェクト ID の交通機関オブジェクトを返します。
|
Insert | |
---|---|
指定された ID とプロパティの交通機関オブジェクトを挿入します。
|
List | |
---|---|
指定された発行者 ID のすべての交通機関オブジェクトのリストを返します。
|
Patch | |
---|---|
指定されたオブジェクト ID によって参照される交通機関オブジェクトを更新します。このメソッドは、パッチのセマンティクスをサポートします。
|
Update | |
---|---|
指定されたオブジェクト ID によって参照される交通機関オブジェクトを更新します。
|
PurchaseDetails
フィールド | |
---|---|
purchase_receipt_number |
チケットの販売者を介したチケット購入を追跡するための領収書番号 / ID。 |
purchase_date_time |
チケットの購入日時。 これは、ISO 8601 拡張形式の日付 / 時刻です。オフセットを指定することもできます。時刻は、ナノ秒の精度まで指定できます。オフセットは秒の精度で指定できます(オフセット秒は ISO 8601 には含まれていません)。 例:
オフセット情報がない場合、高度な機能の一部を使用できないことがあります。 |
account_id |
チケットの購入に使用されたアカウントの ID。 |
confirmation_code |
購入の確認コード。これは複数の異なるチケットで同じ場合があり、チケットをグループ化するために使用されます。 |
ticket_cost |
チケットの費用。 |
TicketCost
フィールド | |
---|---|
face_value |
チケットの額面金額。 |
purchase_price |
税金や割引を適用した後のチケットの実際の購入価格。 |
discount_message |
適用されたあらゆる種類の割引を示すメッセージ。 |
TicketLeg
フィールド | |
---|---|
origin_station_code |
交通機関の出発地のコード。これは、 |
origin_name |
交通機関の出発地の名前。これは、 |
destination_station_code |
交通機関の目的地のコード。 |
destination_name |
目的地の名前。 |
departure_date_time |
出発の日付 / 時刻。これは、交通機関オブジェクトに有効期間が設定されていない場合に必要です。 これは、ISO 8601 拡張形式の日付 / 時刻です。オフセットを指定することもできます。時刻は、ナノ秒の精度まで指定できます。オフセットは秒の精度で指定できます(オフセット秒は ISO 8601 には含まれていません)。 例:
日付 / 時刻の部分にオフセットがない場合、その日付 / 時刻は「ローカルの日付 / 時刻」とみなされます。これは、出発地のローカルの日付 / 時刻である必要があります。たとえば、出発地の現地時間で 2018 年 6 月 5 日の 20 時に出発の場合、ローカルの日付 / 時刻の部分は オフセット情報がない場合、高度な機能の一部を使用できないことがあります。 |
arrival_date_time |
到着の日付 / 時刻。 これは、ISO 8601 拡張形式の日付 / 時刻です。オフセットを指定することもできます。時刻は、ナノ秒の精度まで指定できます。オフセットは秒の精度で指定できます(オフセット秒は ISO 8601 には含まれていません)。 例:
日付 / 時刻の部分にオフセットがない場合、その日付 / 時刻は「ローカルの日付 / 時刻」とみなされます。これは、交通機関の目的地のローカルの日付 / 時刻である必要があります。たとえば、目的地の現地時間で 2018 年 6 月 5 日の 20 時にイベントが開催される場合、ローカルの日付 / 時刻の部分は オフセット情報がない場合、高度な機能の一部を使用できないことがあります。 |
fare_name |
この旅行区間の運賃の簡単な説明 / 名前。たとえば、「いつでも 1 回のみ使用」です。 |
carriage |
乗客が乗る必要がある列車または船の名前 / 番号。 |
platform |
乗客が乗るために使用するプラットホームまたはゲート。 |
zone |
プラットホーム内の乗車位置。 |
ticket_seat |
乗客の指定席。複数の座席を指定する場合は、代わりに |
ticket_seats[] |
乗客の指定席。座席を 1 つのみ指定する場合は、代わりに |
transit_operator_name |
この旅行区間を運行している交通事業者の名前。 |
transit_terminus_name |
列車 / バスなどの終点または目的地。 |
TicketRestrictions
フィールド | |
---|---|
route_restrictions |
使用できるルートに関する制限。たとえば、これは「予約済みの CrossCountry 社の列車のみ」という文字列です。 |
route_restrictions_details |
上記の |
time_restrictions |
このチケットを使用できる時間に関する制限。 |
other_restrictions |
「ルート」または「時間」カテゴリに該当しないその他の制限。 |
TicketSeat
フィールド | |
---|---|
fare_class |
指定された座席の運賃クラス。 |
custom_fare_class |
|
coach |
指定された座席がある車両の識別子。例: 「10」 |
seat |
指定された座席がある場所の識別子。例: 「42」。特定の ID がない場合は、代わりに |
seat_assignment |
乗客の席の割り当て。例: 「特定の座席なし」。 |
FareClass
列挙型 | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
|
FIRST |
|
first |
|
BUSINESS |
|
business |
|
TransitClass
フィールド | |
---|---|
transit_operator_name |
交通事業者の名前。 |
logo |
必須。チケットのロゴ画像。この画像は、アプリのカード詳細ビューに表示されます。 |
transit_type |
必須。このクラスが表す交通機関のタイプ(「バス」など)。 |
watermark |
ユーザーのデバイスに表示する透かし画像。 |
language_override |
このフィールドが存在する場合、ユーザーのデバイスに配信される乗車券は常にこの言語で表されます。BCP 47 言語タグを表します。たとえば、「en-US」、「en-GB」、「de」、「de-AT」など。 |
custom_transit_terminus_name_label |
終点名の値( |
custom_ticket_number_label |
チケット番号の値( |
custom_route_restrictions_label |
利用ルート制限の値( |
custom_route_restrictions_details_label |
利用ルート制限の詳細値( |
custom_time_restrictions_label |
時間制限の詳細値( |
custom_other_restrictions_label |
他の制限値( |
custom_purchase_receipt_number_label |
購入領収書番号の値( |
custom_confirmation_code_label |
確認コードの値( |
custom_purchase_face_value_label |
購入額面金額( |
custom_purchase_price_label |
購入価格の値( |
custom_discount_message_label |
交通機関割引メッセージの値( |
custom_carriage_label |
車両の値( |
custom_seat_label |
座席位置の値( |
custom_coach_label |
普通席の値( |
custom_platform_label |
乗車ホームの値( |
custom_zone_label |
乗車位置の値( |
custom_fare_class_label |
運賃クラスの値( |
custom_concession_category_label |
乗車割引カテゴリの値( |
custom_fare_name_label |
運賃名の値( |
class_template_info |
クラスの表示方法に関するテンプレート情報。設定しない場合、デフォルトの表示フィールドになります。 |
enable_single_leg_itinerary |
このクラスの片道旅程の表示を制御します。デフォルトでは、旅程は往復のみ表示されます。 |
id |
必須。クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
version |
非推奨 |
issuer_name |
必須。発行者の名前。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。 |
messages[] |
アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。このフィールドの最大数は 10 です。 |
allow_multiple_users_per_object |
非推奨。代わりに |
homepage_uri |
アプリケーションのホームページの URI。このフィールドに URI を指定したときの動作は、linksModuleData に URI を指定したときの動作とまったく同じです(オブジェクトがレンダリングされるときに、一般的にオブジェクトの linksModuleData セクションと考えられる場所にホームページのリンクが表示されます)。 |
locations[] |
|
review_status |
必須。クラスのステータス。挿入、パッチ、更新の API 呼び出しを使用して クラスが開発中の場合は、この項目を クラス使用の準備が整ったら、この項目を 既存の |
review |
クラスが |
info_module_data |
非推奨。代わりに textModulesData を使用してください。 |
image_modules_data[] |
画像モジュールのデータ。この表示されるフィールドの最大数は、オブジェクト レベルから 1 個、クラス オブジェクト レベルでは 1 個です。 |
text_modules_data[] |
テキスト モジュールのデータ。テキスト モジュールのデータがクラスにも定義されている場合、両方が表示されます。この表示されるフィールドの最大数は、オブジェクトから 10 個、クラスから 10 個です。 |
links_module_data |
リンク モジュールのデータ。リンク モジュールのデータがオブジェクトにも定義されている場合、両方が表示されます。 |
redemption_issuers[] |
スマートタップ対応のパートナーのみが利用できます。詳細については、サポートにお問い合わせください。 |
country_code |
カードの国を表示するために使用される国コード(ユーザーがその国にいない場合)。あるいは、ユーザーのロケールでコンテンツが利用できない場合にローカライズされたコンテンツを表示するために使用される国コード。 |
hero_image |
カードの表面に表示されるオプションのバナー画像。バナー画像がない場合は、何も表示されません。画像は 100% の幅で表示されます。 |
word_mark |
非推奨。 |
enable_smart_tap |
スマートタップ対応のパートナーのみが利用できます。詳細については、サポートにお問い合わせください。 |
hex_background_color |
カードの背景色。設定されていない場合は、ヒーロー画像の主要色が使用され、ヒーロー画像が設定されていない場合は、ロゴの主要色が使用されます。形式は #rrggbb です( |
localized_issuer_name |
issuer_name の翻訳文字列。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。 |
multiple_devices_and_holders_allowed_status |
このクラスを参照する同じオブジェクトを保存するユーザーやデバイスが複数かどうかを指定します。 |
callback_options |
コールバック オプション。エンドユーザーがこのクラスのオブジェクトを保存または削除するたびに発行者をコールバックするために使用します。このクラスのすべてのオブジェクトは、コールバックの対象となります。 |
TransitType
列挙型 | |
---|---|
TRANSIT_TYPE_UNSPECIFIED |
|
BUS |
|
bus |
|
RAIL |
|
rail |
|
TRAM |
|
tram |
|
FERRY |
|
ferry |
|
OTHER |
|
other |
|
TransitClassAddMessageRequest
フィールド | |
---|---|
resource_id |
クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
add_message_request |
リクエストの本文。 |
TransitClassAddMessageResponse
フィールド | |
---|---|
resource |
更新される TransitClass リソース。 |
TransitClassGetRequest
フィールド | |
---|---|
resource_id |
クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
TransitClassInsertRequest
フィールド | |
---|---|
resource |
リクエストの本文。 |
TransitClassListRequest
フィールド | |
---|---|
issuer_id |
クラスをリストする権限を持つ発行者の ID。 |
token |
|
max_results |
リストから返される結果の最大数を示します。 |
TransitClassListResponse
フィールド | |
---|---|
resources[] |
リスト リクエストに対応するリソース。 |
pagination |
レスポンスのページ分け。 |
TransitClassPatchRequest
フィールド | |
---|---|
resource_id |
クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
resource |
リクエストの本文。 |
TransitClassUpdateRequest
フィールド | |
---|---|
resource_id |
クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
resource |
リクエストの本文。 |
TransitObject
フィールド | |
---|---|
class_reference |
親クラスの継承された項目のコピー。この項目は、GET 中に取得されます。 |
ticket_number |
チケットの番号。これは、交通事業者のシステムでのチケットの一意の識別子です。 |
passenger_type |
乗客の数。 |
passenger_names |
チケットが割り当てられている乗客の名前。上記の |
trip_id |
この ID は、ユーザーが同じ旅行のチケットを複数保存している場合に、チケットをグループ化するために使用されます。 |
ticket_status |
チケットのステータス。表示に影響する状態については、代わりに |
custom_ticket_status |
|
concession_category |
チケットの割引カテゴリ。 |
custom_concession_category |
|
ticket_restrictions |
このチケットの使用制限に関する情報。たとえば、どの曜日に使用する必要があるかや、どのルートを使用できるかなどです。 |
purchase_details |
このチケットの購入の詳細。 |
ticket_leg |
1 つのチケット区間に発着情報と搭乗および座席の情報が含まれています。複数の区間を指定する場合は、代わりに |
ticket_legs[] |
各チケットに 1 つ以上の区間が含まれています。各区間に発着情報と搭乗および座席の情報が含まれています。1 つの区間のみを指定する場合は、代わりに |
hex_background_color |
カードの背景色。設定されていない場合は、ヒーロー画像の主要色が使用され、ヒーロー画像が設定されていない場合は、ロゴの主要色が使用されます。形式は #rrggbb です( |
trip_type |
必須。この交通機関オブジェクトが表す旅行のタイプ。出発地と目的地の間で使用するマークを決定するために使用されます。 |
id |
必須。オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
class_id |
必須。このオブジェクトに関連付けられたクラス。クラスはこのオブジェクトと同じ型で、すでに存在し、承認される必要があります。 クラス ID には、issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。 |
version |
非推奨 |
state |
必須。オブジェクトの状態。このフィールドは、アプリでのオブジェクトの表示方法を決定するために使用されます。たとえば、 |
barcode |
バーコードのタイプと値。 |
messages[] |
アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。このフィールドの最大数は 10 です。 |
valid_time_interval |
このオブジェクトが |
locations[] |
オブジェクトを使用できる場所のリスト。この情報は、位置情報の通知をトリガーするために使用されます。オブジェクト内の場所、クラス内の場所、Google プレイス ID の場所の順に優先されます。 |
has_users |
オブジェクトにユーザーが存在するかどうかを示します。このフィールドはプラットフォームによって設定されます。 |
smart_tap_redemption_value |
スマートタップ対応のパートナーのみが利用できます。詳細については、サポートにお問い合わせください。 |
has_linked_device |
このオブジェクトが現在 1 つのデバイスにリンクされているかどうか。この項目は、ユーザーがオブジェクトを保存し、オブジェクトがデバイスにリンクされているときに、プラットフォームによって設定されます。一部のパートナーが使用することを想定しています。詳細については、サポートにお問い合わせください。 |
disable_expiration_notification |
通知を明示的に止めるかどうかを示します。この項目が true に設定されている場合、 現在、これはクーポンにのみ設定できます。 |
info_module_data |
非推奨。代わりに textModulesData を使用してください。 |
image_modules_data[] |
画像モジュールのデータ。この表示されるフィールドの最大数は、オブジェクト レベルから 1 個、クラス オブジェクト レベルでは 1 個です。 |
text_modules_data[] |
テキスト モジュールのデータ。テキスト モジュールのデータがクラスにも定義されている場合、両方が表示されます。この表示されるフィールドの最大数は、オブジェクトから 10 個、クラスから 10 個です。 |
links_module_data |
リンク モジュールのデータ。リンク モジュールのデータがクラスにも定義されている場合、両方が表示されます。 |
app_link_data |
パートナー アプリリンクに関する補足情報。 |
ConcessionCategory
列挙型 | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
|
CHILD |
|
child |
|
SENIOR |
|
senior |
|
PassengerType
列挙型 | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
|
MULTIPLE_PASSENGERS |
|
multiplePassengers |
|
TicketStatus
列挙型 | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
|
REFUNDED |
|
refunded |
|
EXCHANGED |
|
exchanged |
|
TripType
列挙型 | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
|
ONE_WAY |
|
oneWay |
|
TransitObjectAddMessageRequest
フィールド | |
---|---|
resource_id |
オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
add_message_request |
リクエストの本文。 |
TransitObjectAddMessageResponse
フィールド | |
---|---|
resource |
更新される TransitObject リソース。 |
TransitObjectGetRequest
フィールド | |
---|---|
resource_id |
オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
TransitObjectInsertRequest
フィールド | |
---|---|
resource |
リクエストの本文。 |
TransitObjectListRequest
フィールド | |
---|---|
class_id |
オブジェクトがリストされるクラスの ID。 |
token |
|
max_results |
リストから返される結果の最大数を示します。 |
TransitObjectListResponse
フィールド | |
---|---|
resources[] |
リスト リクエストに対応するリソース。 |
pagination |
レスポンスのページ分け。 |
TransitObjectPatchRequest
フィールド | |
---|---|
resource_id |
オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
resource |
リクエストの本文。 |
TransitObjectUpdateRequest
フィールド | |
---|---|
resource_id |
オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
resource |
リクエストの本文。 |