工具:list_pass_classes
检索与经过身份验证的用户关联的 Google 钱包商家控制台中注册的所有卡券类的完整列表。该工具为管理钱包通行证(如会员卡、礼品卡或航班)的开发者提供重要信息。
以下代码示例展示了如何使用 curl 调用 list_pass_classes MCP 工具。
| Curl 请求 |
|---|
curl --location 'https://paydeveloper.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "list_pass_classes", "arguments": { // Provide these details according to the MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
输入架构
请求列出发行人的通行证类别。
ListPassClassesRequest
| JSON 表示法 |
|---|
{ "issuerId": string, "passType": enum ( |
| 字段 | |
|---|---|
issuerId |
必需。要列出卡券类的发卡机构的唯一标识符。 |
passType |
可选。要列出的卡券类的类型。如果未指定,则返回所有类型的卡券类。 |
view |
可选。指定要为每个卡券类返回的详细程度。 |
PassType
及格等级的类型。
| 枚举 | |
|---|---|
PASS_TYPE_UNSPECIFIED |
未指定通行证类型。 |
LOYALTY |
卡券类型为“会员卡”。 |
GIFT_CARD |
通行证类型为礼品卡。 |
OFFER |
通行证类型为优惠。 |
EVENT_TICKET |
卡券类型为活动门票。 |
FLIGHT |
卡券类型为“航班”。 |
TRANSIT |
卡券类型为“公交”。 |
GENERIC |
卡券类型为“通用”。 |
PassClassView
每个通道类别要返回的详细程度。
| 枚举 | |
|---|---|
PASS_CLASS_VIEW_UNSPECIFIED |
默认值 / 未设置的值。API 将默认使用 BASIC 视图。 |
PASS_CLASS_VIEW_BASIC |
包含有关套票课程的基本信息。 |
PASS_CLASS_VIEW_FULL |
包含卡券类的所有详细信息。 |
输出架构
用于列出发卡机构的卡券类的响应消息。
ListPassClassesResponse
| JSON 表示法 |
|---|
{
"passClasses": [
{
object ( |
| 字段 | |
|---|---|
passClasses[] |
发卡机构的卡券类。 |
PassClass
| JSON 表示法 |
|---|
{ // Union field |
| 字段 | |
|---|---|
联合字段
|
|
loyaltyClass |
可选。发卡机构的会员卡类。 |
giftCardClass |
可选。发卡机构的礼品卡类。 |
offerClass |
可选。发卡机构的优惠类别。 |
eventTicketClass |
可选。发卡机构的活动门票类。 |
flightClass |
可选。发行人的航班舱位。 |
transitClass |
可选。签发方的公交类别。 |
genericClass |
可选。发行者的通用类。 |
LoyaltyClass
| JSON 表示法 |
|---|
{ "id": string, "issuerName": string, "localizedIssuerName": { object ( |
| 字段 | |
|---|---|
id |
可选。忠诚度类的 ID。 |
issuerName |
可选。会员回馈类的发行方名称。 |
localizedIssuerName |
可选。忠诚度等级的本地化发行机构名称。 |
programName |
可选。相应会员等级的计划名称。 |
localizedProgramName |
可选。相应会员等级的本地化会员回馈活动名称。 |
programLogoUri |
可选。相应会员等级的计划徽标。 |
hexBackgroundColor |
可选。会员等级的背景颜色。格式为十六进制颜色字符串,例如“#RRGGBB”。 |
heroImageUri |
可选。在会员卡正面显示的横幅图片。 |
discoverableProgram |
可选。有关如何在 Google 钱包中发现和实例化会员卡类的信息。 |
classTemplateInfo |
可选。有关应如何显示会员等级的模板信息。 |
LocalizedString
| JSON 表示法 |
|---|
{ "translatedValues": [ { object ( |
| 字段 | |
|---|---|
translatedValues[] |
可选。该字符串的翻译字符串。 |
defaultValue |
可选。如果没有合适的翻译,则显示此字符串。 |
TranslatedString
| JSON 表示法 |
|---|
{ "languageCode": string, "value": string } |
| 字段 | |
|---|---|
languageCode |
可选。BCP 47 语言标记。示例值为“en-US”“en-GB”“de”或“de-AT”。 |
value |
可选。以 UTF-8 编码的已翻译字符串。 |
DiscoverableProgram
| JSON 表示法 |
|---|
{ "merchantSignupInfo": { object ( |
| 字段 | |
|---|---|
merchantSignupInfo |
可选。有关能否通过商家网站注册加入此可发现的计划并添加有价卡券的信息。 |
merchantSigninInfo |
可选。有关能否通过商家网站登录此可发现的计划并添加有价卡券的信息。 |
state |
仅限输出。可发现的计划的状态。 |
MerchantSignupInfo
| JSON 表示法 |
|---|
{ "signupWebsite": { object ( |
| 字段 | |
|---|---|
signupWebsite |
可选。用于注册可发现的计划的网站。 |
signupSharedDatas[] |
可选。通过 POST 请求发送到注册网站网址的用户数据。此信息已编码并共享,以便商家网站能够预填充用户注册加入可发现计划时使用的字段。 |
URI
| JSON 表示法 |
|---|
{
"uri": string,
"description": string,
"localizedDescription": {
object ( |
| 字段 | |
|---|---|
uri |
可选。URI。 |
description |
可选。在 Google 钱包中以文本显示的 URI 标题。 |
localizedDescription |
可选。在 Google 钱包中以文本形式显示的 URI 标题的已翻译字符串。 |
MerchantSigninInfo
| JSON 表示法 |
|---|
{
"signinWebsite": {
object ( |
| 字段 | |
|---|---|
signinWebsite |
可选。注册参与该探索性计划的网站。 |
ClassTemplateInfo
| JSON 表示法 |
|---|
{ "cardBarcodeSectionDetails": { object ( |
| 字段 | |
|---|---|
cardBarcodeSectionDetails |
可选。要在条形码上方和下方显示的额外信息。 |
cardTemplateOverride |
可选。卡片视图的模板替换。 |
detailsTemplateOverride |
可选。详情视图的模板替换。 |
listTemplateOverride |
可选。卡券列表视图的模板替换。 |
CardBarcodeSectionDetails
| JSON 表示法 |
|---|
{ "firstTopDetail": { object ( |
| 字段 | |
|---|---|
firstTopDetail |
可选。要在条形码上方显示的可选信息。如果定义了 secondTopDetail,它将显示在此详细信息部分开头处的一端。 |
firstBottomDetail |
可选。要在条形码下方显示的可选信息。 |
secondTopDetail |
可选。在条形码上方显示的第二条可选信息。如果定义了 firstTopDetail,它将显示在此详细信息部分末尾处的一端。 |
BarcodeSectionDetail
| JSON 表示法 |
|---|
{
"fieldSelector": {
object ( |
| 字段 | |
|---|---|
fieldSelector |
可选。对要显示的现有基于文本的字段或图片字段的引用。 |
FieldSelector
| JSON 表示法 |
|---|
{
"fields": [
{
object ( |
| 字段 | |
|---|---|
fields[] |
可选。要与字段替换搭配使用的字段引用。如果提供多个引用,则将显示第一个引用非空字段的引用。 |
FieldReference
| JSON 表示法 |
|---|
{
"fieldPath": string,
"dateFormat": enum ( |
| 字段 | |
|---|---|
fieldPath |
可选。指向所引用字段的路径,带有“object”或“class”前缀,并以圆点分隔。 |
dateFormat |
可选。用于呈现日期/时间字段的日期格式。 |
CardTemplateOverride
| JSON 表示法 |
|---|
{
"cardRowTemplateInfos": [
{
object ( |
| 字段 | |
|---|---|
cardRowTemplateInfos[] |
可选。卡片视图中行的模板信息。最多可以指定三行。 |
CardRowTemplateInfo
| JSON 表示法 |
|---|
{ // Union field |
| 字段 | |
|---|---|
联合字段 row_template。包含一个、两个或三个项目的行模板。row_template 只能是下列其中一项: |
|
oneItem |
可选。包含一项的行的模板。 |
twoItems |
可选。包含两项的行的模板。 |
threeItems |
可选。包含三项的行的模板。 |
CardRowOneItem
| JSON 表示法 |
|---|
{
"item": {
object ( |
| 字段 | |
|---|---|
item |
可选。要在行中显示的项。此项目将居中显示。 |
TemplateItem
| JSON 表示法 |
|---|
{ "firstValue": { object ( |
| 字段 | |
|---|---|
firstValue |
可选。对要显示的第一个字段的引用。 |
secondValue |
可选。要显示的第二个字段的引用。 |
predefinedItem |
可选。要显示的预定义项。 |
CardRowTwoItems
| JSON 表示法 |
|---|
{ "startItem": { object ( |
| 字段 | |
|---|---|
startItem |
可选。要在行开头显示的项。此项会靠左对齐。 |
endItem |
可选。要在行末尾显示的项。此项会靠右对齐。 |
CardRowThreeItems
| JSON 表示法 |
|---|
{ "startItem": { object ( |
| 字段 | |
|---|---|
startItem |
可选。要在行开头显示的项。此项会靠左对齐。 |
middleItem |
可选。显示在行中间的商品。此项目将位于起始项目和结束项目之间居中显示。 |
endItem |
可选。要在行末尾显示的项。此项会靠右对齐。 |
DetailsTemplateOverride
| JSON 表示法 |
|---|
{
"detailsItemInfos": [
{
object ( |
| 字段 | |
|---|---|
detailsItemInfos[] |
可选。有关显示在详细信息列表中的项的模板信息。 |
DetailsItemInfo
| JSON 表示法 |
|---|
{
"item": {
object ( |
| 字段 | |
|---|---|
item |
可选。要在详细信息列表中显示的项。 |
ListTemplateOverride
| JSON 表示法 |
|---|
{ "firstRowOption": { object ( |
| 字段 | |
|---|---|
firstRowOption |
可选。对要显示在第一行中的字段的引用。 |
secondRowOption |
可选。指向第二行要显示的字段的引用。 |
FirstRowOption
| JSON 表示法 |
|---|
{ "transitOption": enum ( |
| 字段 | |
|---|---|
transitOption |
可选。要显示在第一行的公交选项。 |
fieldOption |
可选。对要显示在第一行中的字段的引用。 |
GiftCardClass
| JSON 表示法 |
|---|
{ "id": string, "issuerName": string, "localizedIssuerName": { object ( |
| 字段 | |
|---|---|
id |
可选。礼品卡类的 ID。 |
issuerName |
可选。礼品卡类的发卡机构名称。 |
localizedIssuerName |
可选。礼品卡类的本地化发卡机构名称。 |
merchantName |
可选。礼品卡类别的商家名称。 |
localizedMerchantName |
可选。礼品卡类别的本地化商家名称。 |
programLogoUri |
可选。礼品卡类的计划徽标。 |
hexBackgroundColor |
可选。礼品卡类的背景颜色。格式为十六进制颜色字符串,例如“#RRGGBB”。 |
heroImageUri |
可选。显示在礼品卡课程正面的横幅图片。 |
homePageUri |
可选。该应用程序的网站主页。 |
classTemplateInfo |
可选。礼品卡类别的显示方式模板信息。 |
OfferClass
| JSON 表示法 |
|---|
{ "id": string, "issuerName": string, "localizedIssuerName": { object ( |
| 字段 | |
|---|---|
id |
可选。优惠类的 ID。 |
issuerName |
可选。优惠类的发卡机构名称。 |
localizedIssuerName |
可选。优惠类的本地化发行方名称。 |
provider |
可选。相应优惠类的提供方。 |
localizedProvider |
可选。优惠类的本地化提供方。 |
title |
可选。优惠类的标题。 |
localizedTitle |
可选。优惠类的本地化标题。 |
titleImageUri |
可选。优惠类的标题图片。 |
hexBackgroundColor |
可选。优惠类的背景颜色。格式为十六进制颜色字符串,例如“#RRGGBB”。 |
heroImageUri |
可选。显示在优惠类正面的横幅图片。 |
redemptionChannel |
可选。优惠类的兑换渠道。 |
classTemplateInfo |
可选。有关应如何显示优惠类的模板信息。 |
EventTicketClass
| JSON 表示法 |
|---|
{ "id": string, "issuerName": string, "localizedIssuerName": { object ( |
| 字段 | |
|---|---|
id |
可选。活动门票类别的 ID。 |
issuerName |
可选。活动门票类的发卡机构名称。 |
localizedIssuerName |
可选。活动门票类的本地化发卡机构名称。 |
logoUri |
可选。活动门票类的徽标。 |
eventName |
可选。事件名称。 |
venue |
可选。活动的场地。 |
dateTime |
可选。活动日期和时间的相关信息。 |
hexBackgroundColor |
可选。活动门票类别的背景颜色。格式为十六进制颜色字符串,例如“#RRGGBB”。 |
heroImageUri |
可选。显示在活动门票类正面的横幅图片。 |
classTemplateInfo |
可选。有关应如何显示活动门票类的模板信息。 |
EventVenue
| JSON 表示法 |
|---|
{ "name": { object ( |
| 字段 | |
|---|---|
name |
可选。场所的名称。 |
address |
可选。活动地点的地址。 |
EventDateTime
| JSON 表示法 |
|---|
{ "start": string, "end": string } |
| 字段 | |
|---|---|
start |
可选。活动开始的日期/时间。如果活动持续数天,则应为第一天的开始日期/时间。格式为 ISO 8601 扩展格式的日期/时间,不带偏移量,时间可以精确到毫秒,例如 2027-03-05T06:30:00。 |
end |
可选。活动的结束日期/时间。如果活动持续数天,则应是活动最后一天的结束日期/时间。格式为 ISO 8601 扩展格式的日期/时间,不带偏移量,时间可以精确到毫秒,例如 2027-03-05T06:30:00。 |
FlightClass
| JSON 表示法 |
|---|
{ "id": string, "issuerName": string, "localizedIssuerName": { object ( |
| 字段 | |
|---|---|
id |
可选。航班舱位的 ID。 |
issuerName |
可选。机票舱位的发行机构名称。 |
localizedIssuerName |
可选。机票舱位的本地化发行方名称。 |
flightHeader |
可选。关于航空公司和航班号的信息。 |
origin |
可选。有关出发地机场的信息。 |
destination |
可选。目的地机场的相关信息。 |
localScheduledDepartureDateTime |
可选。飞机离开登机口(而不是跑道)的预定日期和时间。格式为 ISO 8601 扩展格式的日期/时间,不带偏移量,时间可以精确到毫秒,例如 2027-03-05T06:30:00。此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。 |
hexBackgroundColor |
可选。机票舱位的背景颜色。格式为十六进制颜色字符串,例如“#RRGGBB”。 |
heroImageUri |
可选。显示在航班舱位正面的横幅图片。 |
classTemplateInfo |
可选。有关应如何显示航班舱位的模板信息。 |
FlightHeader
| JSON 表示法 |
|---|
{
"carrier": {
object ( |
| 字段 | |
|---|---|
carrier |
可选。有关航空公司的信息。 |
flightNumber |
可选。不含航空公司 IATA 代码的航班号。相应字段仅包含数字,例如“123”。 |
FlightCarrier
| JSON 表示法 |
|---|
{ "carrierIataCode": string, "carrierIcaoCode": string, "airlineLogoUri": string } |
| 字段 | |
|---|---|
carrierIataCode |
可选。航空公司的 IATA 代码(2 个字符)。 |
carrierIcaoCode |
可选。承运航空公司的 ICAO 航空公司代码(3 个字符)。 |
airlineLogoUri |
可选。由承运航空公司 IATA 代码描述的航空公司徽标。 |
AirportInfo
| JSON 表示法 |
|---|
{ "airportIataCode": string, "terminal": string, "gate": string } |
| 字段 | |
|---|---|
airportIataCode |
可选。IATA 机场代码(3 个字符),例如“SFO”。 |
terminal |
可选。航站楼名称,例如“I”。 |
gate |
可选。登机口名称,例如“B59”。 |
TransitClass
| JSON 表示法 |
|---|
{ "id": string, "issuerName": string, "localizedIssuerName": { object ( |
| 字段 | |
|---|---|
id |
可选。公交类的 ID。 |
issuerName |
可选。公交卡类的发卡机构名称。 |
localizedIssuerName |
可选。公交卡类的本地化发行方名称。 |
hexBackgroundColor |
可选。公交类别的背景颜色。格式为十六进制颜色字符串,例如“#RRGGBB”。 |
heroImageUri |
可选。显示在公交类正面的横幅图片。 |
transitType |
可选。公交类别的公交类型。 |
classTemplateInfo |
可选。有关应如何显示公交类别的模板信息。 |
GenericClass
| JSON 表示法 |
|---|
{
"id": string,
"classTemplateInfo": {
object ( |
| 字段 | |
|---|---|
id |
可选。通用类的 ID。 |
classTemplateInfo |
可选。模板信息,用于说明如何显示通用类。 |
注册时要与商家分享的用户数据类型。
| 枚举 | |
|---|---|
SHARED_DATA_TYPE_UNSPECIFIED |
未指定的共享数据类型。 |
FIRST_NAME |
用户的名字。 |
LAST_NAME |
用户的姓氏。 |
STREET_ADDRESS |
用户的单行地址。 |
ADDRESS_LINE_ONE |
用户的地址行一。 |
ADDRESS_LINE_TWO |
用户的地址行 2。 |
ADDRESS_LINE_THREE |
用户的地址行 3。 |
CITY |
用户的城市。 |
STATE |
用户的状态。 |
ZIPCODE |
用户的邮政编码。 |
COUNTRY |
用户所在的国家/地区。 |
EMAIL |
用户的电子邮件地址。 |
PHONE |
用户的电话号码。 |
州
可发现的计划的状态。
| 枚举 | |
|---|---|
STATE_UNSPECIFIED |
状态未指定。 |
TRUSTED_TESTERS |
只有具有发卡机构账号访问权限的测试人员才能查看该计划。 |
LIVE |
所有用户都能看到该节目。 |
DISABLED |
计划不可见。 |
DateFormat
用于呈现日期/时间字段的日期格式。
| 枚举 | |
|---|---|
DATE_FORMAT_UNSPECIFIED |
日期格式未指定。 |
DATE_TIME |
例如,在 en_US 中,2018-12-14T13:00:00 会呈现为 12 月 14 日下午 1:00。 |
DATE_ONLY |
例如,在 en_US 中,2018-12-14T13:00:00 会呈现为 12 月 14 日。 |
TIME_ONLY |
例如,在 en_US 中,2018-12-14T13:00:00 会呈现为下午 1:00。 |
DATE_TIME_YEAR |
例如,在 en_US 中,2018-12-14T13:00:00 会呈现为 2018 年 12 月 14 日下午 1:00。 |
DATE_YEAR |
例如,在 en_US 中,2018-12-14T13:00:00 会呈现为 2018 年 12 月 14 日。 |
YEAR_MONTH |
例如,在 en_US 中,2018-12-14T13:00:00 会呈现为 2018-12。 |
YEAR_MONTH_DAY |
例如,在 en_US 中,2018-12-14T13:00:00 会呈现为 2018-12-14。 |
PredefinedItem
要显示的预定义项。
| 枚举 | |
|---|---|
PREDEFINED_ITEM_UNSPECIFIED |
未指定预定义项。 |
FREQUENT_FLYER_PROGRAM_NAME_AND_NUMBER |
预定义项是飞行常客奖励计划名称和编号。 |
FLIGHT_NUMBER_AND_OPERATING_FLIGHT_NUMBER |
预定义项是航班号和承运航班号。 |
TransitOption
要显示的公交选项。
| 枚举 | |
|---|---|
TRANSIT_OPTION_UNSPECIFIED |
未指定公交选项。 |
ORIGIN_AND_DESTINATION_NAMES |
公交选项是出发地和目的地名称。 |
ORIGIN_AND_DESTINATION_CODES |
中转选项是出发地和目的地代码。 |
ORIGIN_NAME |
运输选项是出发地名称。 |
RedemptionChannel
此优惠适用的兑换渠道。
| 枚举 | |
|---|---|
REDEMPTION_CHANNEL_UNSPECIFIED |
未指定兑换渠道。 |
IN_STORE |
此优惠仅限实体店内兑换。 |
ONLINE |
此优惠只能在线兑换。 |
BOTH |
此优惠可在实体店内或网上兑换。 |
TEMPORARY_PRICE_REDUCTION |
这是暂时的降价优惠。 |
TransitType
公交类别的公交类型。
| 枚举 | |
|---|---|
TRANSIT_TYPE_UNSPECIFIED |
未指定公交类型。 |
BUS |
公交类型为“公交车”。 |
RAIL |
公交类型为轨道交通。 |
TRAM |
公交类型为有轨电车。 |
FERRY |
公交类型为渡轮。 |
FLIGHT |
公交类型为航班。 |
OTHER |
公交类型为“其他”。 |
工具注释
工具注释会发送给 MCP 客户端,用于描述指定工具的基本风险。大多数客户端会将这些提示视为不受信任的,但它们可用于确定何时向用户发送确认提示。
除了标题字符串之外,还定义了以下布尔值提示:
readOnlyHint:如果为 true,则工具不会修改其环境。默认值:false。destructiveHint:如果为 true,则工具可以执行破坏性操作。如果为 false,则该工具只能执行添加操作。默认值:true。idempotentHint:如果为 true,则使用相同实参重复调用该工具不会对其环境产生任何额外影响。默认值:false。openWorldHint:如果为 true,则工具可以与外部实体的“开放世界”互动。如果为 false,则该工具只能与内部实体互动。例如,网络搜索工具是开放世界工具,而内存工具不是开放世界工具。
破坏性提示:❌ | 等幂性提示:✅ | 只读提示:✅ | 开放世界提示:❌