指数
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 引用的公交类添加消息。
|
|
| 获取 | |
|---|---|
|
返回具有指定类 ID 的公交类。
|
|
| 插入 | |
|---|---|
|
插入具有指定 ID 和属性的公交类。
|
|
| 列表 | |
|---|---|
|
返回指定发卡机构 ID 的所有公交类的列表。
|
|
| 修补 | |
|---|---|
|
更新指定类 ID 引用的公交类。此方法支持补丁语义。
|
|
| 更新 | |
|---|---|
|
更新指定类 ID 引用的公交类。
|
|
TransitObjectService
| AddMessage | |
|---|---|
|
向指定对象 ID 引用的公交对象添加消息。
|
|
| 获取 | |
|---|---|
|
返回具有指定对象 ID 的公交对象。
|
|
| 插入 | |
|---|---|
|
插入具有指定 ID 和属性的公交对象。
|
|
| 列表 | |
|---|---|
|
返回指定发卡机构 ID 的所有公交对象的列表。
|
|
| 修补 | |
|---|---|
|
更新指定对象 ID 引用的公交对象。此方法支持补丁语义。
|
|
| 更新 | |
|---|---|
|
更新指定对象 ID 引用的公交对象。
|
|
PurchaseDetails
| 字段 | |
|---|---|
purchase_receipt_number |
通过售票机构跟踪购票情况所用的收据编号/标识符。 |
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 |
此次行程票价的简短说明/名称。例如“不限时间,单人使用”。 |
carriage |
乘客要搭乘的火车或轮船的名称/编号。 |
platform |
乘客所乘坐的车厢对应的站台或出入口。 |
zone |
站台上的乘车区。 |
ticket_seat |
乘客预订的座位。如果要指定多个座位,请改用 |
ticket_seats[] |
乘客预订的座位。如果仅指定一个座位,请改用 |
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”。如果没有特定标识符,请改用 |
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 |
有关应如何显示类的模板信息。如果未设置,Google 将回退为显示默认字段集。 |
enable_single_leg_itinerary |
控制此类的单段行程的显示。默认情况下仅显示多段行程。 |
id |
必选。类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中前者由 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,其中 rrggbb 为十六进制 RGB 三元组,例如 |
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 IDidentifier”格式,其中前者由 Google 提供,后者由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
add_message_request |
请求的正文。 |
TransitClassAddMessageResponse
| 字段 | |
|---|---|
resource |
更新的 TransitClass 资源。 |
TransitClassGetRequest
| 字段 | |
|---|---|
resource_id |
类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中前者由 Google 提供,后者由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
TransitClassInsertRequest
| 字段 | |
|---|---|
resource |
请求的正文。 |
TransitClassListRequest
| 字段 | |
|---|---|
issuer_id |
有权列出类的发卡机构的 ID。 |
token |
如果已指定 |
max_results |
确定列表返回的结果数上限。如果未定义 |
TransitClassListResponse
| 字段 | |
|---|---|
resources[] |
与列表请求相对应的资源。 |
pagination |
响应的分页。 |
TransitClassPatchRequest
| 字段 | |
|---|---|
resource_id |
类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中前者由 Google 提供,后者由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
resource |
请求的正文。 |
TransitClassUpdateRequest
| 字段 | |
|---|---|
resource_id |
类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中前者由 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 |
单段车票包含出发和到达信息以及乘车和座位信息。如果要指定多段行程,请改用 |
ticket_legs[] |
每张车票可包含一段或多段。每段都包含相应的出发和到达信息以及乘车和座位信息。如果仅指定一段,请改用 |
hex_background_color |
卡片的背景颜色。如果未设置,则使用主打图片的主体色;如果未设置主打图片,则使用徽标的主体色。格式为 #rrggbb,其中 rrggbb 为十六进制 RGB 三元组,例如 |
trip_type |
必选。此公交对象所表示的行程类型。用于确定在起点站和目的地之间使用哪个符号。 |
id |
必选。对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中前者由 Google 提供,后者由您自行选择。该唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
class_id |
必选。与此对象关联的类。该类必须与此对象具有相同的类型、已存在且已获批准。 类 ID 应遵循“issuer IDidentifier”格式,其中前者由 Google 提供,后者由您自行选择。 |
version |
已弃用 |
state |
必选。对象的状态。此字段用于确定对象在应用中的显示方式。例如,系统会将 |
barcode |
条形码的类型和值。 |
messages[] |
在应用中显示的一组消息。此对象的所有用户都将收到其关联消息。这些字段的数量上限为 10。 |
valid_time_interval |
此对象处于 |
locations[] |
可使用对象的位置的列表。平台使用此信息来触发发送给用户的地理定位通知。请注意,对象中的位置会替换类中的位置,而类中的位置又会替换 Google 商家信息 ID 中的位置。 |
has_users |
指明对象是否具有用户。此字段由平台设置。 |
smart_tap_redemption_value |
仅适用于支持智能触碰技术的合作伙伴。如需更多指导,请与支持人员联系。 |
has_linked_device |
指明此对象当前是否已关联到某个设备。当用户保存对象并将其关联到自己的设备时,平台会设置此字段。此字段仅供部分合作伙伴使用。如需获取更多信息,请与支持人员联系。 |
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 IDidentifier”格式,其中前者由 Google 提供,后者由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
add_message_request |
请求的正文。 |
TransitObjectAddMessageResponse
| 字段 | |
|---|---|
resource |
更新的 TransitObject 资源。 |
TransitObjectGetRequest
| 字段 | |
|---|---|
resource_id |
对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中前者由 Google 提供,后者由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
TransitObjectInsertRequest
| 字段 | |
|---|---|
resource |
请求的正文。 |
TransitObjectListRequest
| 字段 | |
|---|---|
class_id |
要列出其对象的类的 ID。 |
token |
如果已指定 |
max_results |
确定列表返回的结果数上限。如果未定义 |
TransitObjectListResponse
| 字段 | |
|---|---|
resources[] |
与列表请求相对应的资源。 |
pagination |
响应的分页。 |
TransitObjectPatchRequest
| 字段 | |
|---|---|
resource_id |
对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中前者由 Google 提供,后者由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
resource |
请求的正文。 |
TransitObjectUpdateRequest
| 字段 | |
|---|---|
resource_id |
对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中前者由 Google 提供,后者由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
resource |
请求的正文。 |