MCP Tools Reference: paydeveloper.googleapis.com

工具:list_pass_classes

检索与经过身份验证的用户关联的 Google 钱包商家控制台中注册的所有卡券类的完整列表。此工具可为管理 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 tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

输入架构

列出发行机构卡券类别的请求消息。

ListPassClassesRequest

JSON 表示法
{
  "issuerId": string,
  "passType": enum (PassType),
  "view": enum (PassClassView)
}
字段
issuerId

string (int64 format)

必需。要列出卡券类的发卡机构的唯一标识符。

passType

enum (PassType)

可选。要列出的卡券类的类型。如果未指定,则返回所有类型的卡券类。

view

enum (PassClassView)

可选。指定要为每个卡券类返回的详细程度。

输出架构

用于列出发卡机构的卡券类的响应消息。

ListPassClassesResponse

JSON 表示法
{
  "passClasses": [
    {
      object (PassClass)
    }
  ]
}
字段
passClasses[]

object (PassClass)

发卡机构的卡券类。

PassClass

JSON 表示法
{

  // Union field resource can be only one of the following:
  "loyaltyClass": {
    object (LoyaltyClass)
  },
  "giftCardClass": {
    object (GiftCardClass)
  },
  "offerClass": {
    object (OfferClass)
  },
  "eventTicketClass": {
    object (EventTicketClass)
  },
  "flightClass": {
    object (FlightClass)
  },
  "transitClass": {
    object (TransitClass)
  },
  "genericClass": {
    object (GenericClass)
  }
  // End of list of possible types for union field resource.
}
字段

联合字段 resource

resource 只能是下列其中一项:

loyaltyClass

object (LoyaltyClass)

可选。发卡机构的会员卡类。

giftCardClass

object (GiftCardClass)

可选。发卡机构的礼品卡类。

offerClass

object (OfferClass)

可选。发卡机构的优惠类别。

eventTicketClass

object (EventTicketClass)

可选。发卡机构的活动门票类。

flightClass

object (FlightClass)

可选。发行方的飞行舱位等级。

transitClass

object (TransitClass)

可选。发行方的公交类别。

genericClass

object (GenericClass)

可选。发卡机构的通用类。

LoyaltyClass

JSON 表示法
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "programName": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "programLogoUri": string,
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
字段
id

string

可选。会员等级的 ID。

issuerName

string

可选。会员回馈类的发行方名称。

localizedIssuerName

object (LocalizedString)

可选。会员等级的本地化发行方名称。

programName

string

可选。会员等级的计划名称。

localizedProgramName

object (LocalizedString)

可选。相应会员等级的本地化计划名称。

programLogoUri

string

可选。相应会员等级的计划徽标。

hexBackgroundColor

string

可选。会员等级的背景颜色。格式为十六进制颜色字符串,例如“#RRGGBB”。

heroImageUri

string

可选。在会员等级正面显示的横幅图片。

discoverableProgram

object (DiscoverableProgram)

可选。有关如何在 Google 钱包中发现和实例化会员卡类的信息。

classTemplateInfo

object (ClassTemplateInfo)

可选。有关应如何显示会员等级的模板信息。

LocalizedString

JSON 表示法
{
  "translatedValues": [
    {
      object (TranslatedString)
    }
  ],
  "defaultValue": {
    object (TranslatedString)
  }
}
字段
translatedValues[]

object (TranslatedString)

可选。相应字符串的已翻译字符串。

defaultValue

object (TranslatedString)

可选。缺少恰当译文时显示的字符串。

TranslatedString

JSON 表示法
{
  "languageCode": string,
  "value": string
}
字段
languageCode

string

可选。BCP 47 语言标记。示例值为“en-US”“en-GB”“de”或“de-AT”。

value

string

可选。以 UTF-8 编码的已翻译字符串。

DiscoverableProgram

JSON 表示法
{
  "merchantSignupInfo": {
    object (MerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (MerchantSigninInfo)
  },
  "state": enum (State)
}
字段
merchantSignupInfo

object (MerchantSignupInfo)

可选。有关能否通过商家网站注册加入此可发现的计划并添加有价卡券的信息。

merchantSigninInfo

object (MerchantSigninInfo)

可选。有关能否通过商家网站登录此可发现的计划并添加有价卡券的信息。

state

enum (State)

仅限输出。可发现的计划的状态。

MerchantSignupInfo

JSON 表示法
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
字段
signupWebsite

object (Uri)

可选。用于注册可发现的计划的网站。

signupSharedDatas[]

enum (SharedDataType)

可选。通过 POST 请求发送到注册网站网址的用户数据。此信息已编码并共享,以便商家网站能够预填充用户注册加入可发现计划时使用的字段。

URI

JSON 表示法
{
  "uri": string,
  "description": string,
  "localizedDescription": {
    object (LocalizedString)
  }
}
字段
uri

string

可选。URI。

description

string

可选。在 Google 钱包中以文本显示的 URI 标题。

localizedDescription

object (LocalizedString)

可选。在 Google 钱包中以文本显示的 URI 标题的翻译后字符串。

MerchantSigninInfo

JSON 表示法
{
  "signinWebsite": {
    object (Uri)
  }
}
字段
signinWebsite

object (Uri)

可选。可发现的计划的登录网站。

ClassTemplateInfo

JSON 表示法
{
  "cardBarcodeSectionDetails": {
    object (CardBarcodeSectionDetails)
  },
  "cardTemplateOverride": {
    object (CardTemplateOverride)
  },
  "detailsTemplateOverride": {
    object (DetailsTemplateOverride)
  },
  "listTemplateOverride": {
    object (ListTemplateOverride)
  }
}
字段
cardBarcodeSectionDetails

object (CardBarcodeSectionDetails)

可选。要在条形码上方和下方显示的额外信息。

cardTemplateOverride

object (CardTemplateOverride)

可选。卡片视图的模板替换。

detailsTemplateOverride

object (DetailsTemplateOverride)

可选。详情视图的模板替换。

listTemplateOverride

object (ListTemplateOverride)

可选。卡券列表视图的模板替换。

CardBarcodeSectionDetails

JSON 表示法
{
  "firstTopDetail": {
    object (BarcodeSectionDetail)
  },
  "firstBottomDetail": {
    object (BarcodeSectionDetail)
  },
  "secondTopDetail": {
    object (BarcodeSectionDetail)
  }
}
字段
firstTopDetail

object (BarcodeSectionDetail)

可选。要在条形码上方显示的可选信息。如果定义了 secondTopDetail,它将显示在此详细信息部分开头处的一端。

firstBottomDetail

object (BarcodeSectionDetail)

可选。要在条形码下方显示的可选信息。

secondTopDetail

object (BarcodeSectionDetail)

可选。要在条形码上方显示的第二条可选信息。如果定义了 firstTopDetail,它将显示在此详细信息部分末尾处的一端。

BarcodeSectionDetail

JSON 表示法
{
  "fieldSelector": {
    object (FieldSelector)
  }
}
字段
fieldSelector

object (FieldSelector)

可选。对要显示的现有基于文本的字段或图片字段的引用。

FieldSelector

JSON 表示法
{
  "fields": [
    {
      object (FieldReference)
    }
  ]
}
字段
fields[]

object (FieldReference)

可选。要与字段替换搭配使用的字段引用。如果提供多个引用,则将显示第一个引用非空字段的引用。

FieldReference

JSON 表示法
{
  "fieldPath": string,
  "dateFormat": enum (DateFormat)
}
字段
fieldPath

string

可选。指向所引用字段的路径,带有“object”或“class”前缀,并以圆点分隔。

dateFormat

enum (DateFormat)

可选。用于呈现日期/时间字段的日期格式。

CardTemplateOverride

JSON 表示法
{
  "cardRowTemplateInfos": [
    {
      object (CardRowTemplateInfo)
    }
  ]
}
字段
cardRowTemplateInfos[]

object (CardRowTemplateInfo)

可选。卡片视图中的行的模板信息。最多可以指定三行。

CardRowTemplateInfo

JSON 表示法
{

  // Union field row_template can be only one of the following:
  "oneItem": {
    object (CardRowOneItem)
  },
  "twoItems": {
    object (CardRowTwoItems)
  },
  "threeItems": {
    object (CardRowThreeItems)
  }
  // End of list of possible types for union field row_template.
}
字段
联合字段 row_template。包含一项、两项或三项的行的模板。row_template 只能是下列其中一项:
oneItem

object (CardRowOneItem)

可选。包含一项的行的模板。

twoItems

object (CardRowTwoItems)

可选。包含两项的行的模板。

threeItems

object (CardRowThreeItems)

可选。包含三项的行的模板。

CardRowOneItem

JSON 表示法
{
  "item": {
    object (TemplateItem)
  }
}
字段
item

object (TemplateItem)

可选。要在行中显示的项。此项将居中显示。

TemplateItem

JSON 表示法
{
  "firstValue": {
    object (FieldSelector)
  },
  "secondValue": {
    object (FieldSelector)
  },
  "predefinedItem": enum (PredefinedItem)
}
字段
firstValue

object (FieldSelector)

可选。对要显示的第一个字段的引用。

secondValue

object (FieldSelector)

可选。要显示的第二个字段的引用。

predefinedItem

enum (PredefinedItem)

可选。要显示的预定义项。

CardRowTwoItems

JSON 表示法
{
  "startItem": {
    object (TemplateItem)
  },
  "endItem": {
    object (TemplateItem)
  }
}
字段
startItem

object (TemplateItem)

可选。要在行开头显示的项。此项会靠左对齐。

endItem

object (TemplateItem)

可选。要在行末尾显示的项。此项会靠右对齐。

CardRowThreeItems

JSON 表示法
{
  "startItem": {
    object (TemplateItem)
  },
  "middleItem": {
    object (TemplateItem)
  },
  "endItem": {
    object (TemplateItem)
  }
}
字段
startItem

object (TemplateItem)

可选。要在行开头显示的项。此项会靠左对齐。

middleItem

object (TemplateItem)

可选。要在行中间显示的项。此项将在开头处的项与末尾处的项之间居中。

endItem

object (TemplateItem)

可选。要在行末尾显示的项。此项会靠右对齐。

DetailsTemplateOverride

JSON 表示法
{
  "detailsItemInfos": [
    {
      object (DetailsItemInfo)
    }
  ]
}
字段
detailsItemInfos[]

object (DetailsItemInfo)

可选。有关显示在详细信息列表中的项的模板信息。

DetailsItemInfo

JSON 表示法
{
  "item": {
    object (TemplateItem)
  }
}
字段
item

object (TemplateItem)

可选。要在详细信息列表中显示的项。

ListTemplateOverride

JSON 表示法
{
  "firstRowOption": {
    object (FirstRowOption)
  },
  "secondRowOption": {
    object (FieldSelector)
  }
}
字段
firstRowOption

object (FirstRowOption)

可选。对要显示在第一行中的字段的引用。

secondRowOption

object (FieldSelector)

可选。对要显示在第二行中的字段的引用。

FirstRowOption

JSON 表示法
{
  "transitOption": enum (TransitOption),
  "fieldOption": {
    object (FieldSelector)
  }
}
字段
transitOption

enum (TransitOption)

可选。要显示在第一行中的公交选项。

fieldOption

object (FieldSelector)

可选。对要显示在第一行中的字段的引用。

GiftCardClass

JSON 表示法
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "merchantName": string,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "programLogoUri": string,
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "homePageUri": {
    object (Uri)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
字段
id

string

可选。礼品卡类的 ID。

issuerName

string

可选。礼品卡类的发卡机构名称。

localizedIssuerName

object (LocalizedString)

可选。礼品卡类的本地化发卡机构名称。

merchantName

string

可选。礼品卡类的商家名称。

localizedMerchantName

object (LocalizedString)

可选。礼品卡类的本地化商家名称。

programLogoUri

string

可选。礼品卡类的计划徽标。

hexBackgroundColor

string

可选。礼品卡类的背景颜色。格式为十六进制颜色字符串,例如“#RRGGBB”。

heroImageUri

string

可选。显示在礼品卡课程正面的横幅图片。

homePageUri

object (Uri)

可选。应用首页的网站。

classTemplateInfo

object (ClassTemplateInfo)

可选。有关应如何显示礼品卡类的模板信息。

OfferClass

JSON 表示法
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "provider": string,
  "localizedProvider": {
    object (LocalizedString)
  },
  "title": string,
  "localizedTitle": {
    object (LocalizedString)
  },
  "titleImageUri": string,
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "redemptionChannel": enum (RedemptionChannel),
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
字段
id

string

可选。优惠类的 ID。

issuerName

string

可选。优惠类的发行方名称。

localizedIssuerName

object (LocalizedString)

可选。优惠类的本地化发行方名称。

provider

string

可选。相应优惠类的提供方。

localizedProvider

object (LocalizedString)

可选。优惠类的本地化提供方。

title

string

可选。优惠类的标题。

localizedTitle

object (LocalizedString)

可选。相应优惠类的本地化标题。

titleImageUri

string

可选。优惠类的标题图片。

hexBackgroundColor

string

可选。优惠券类的背景颜色。格式为十六进制颜色字符串,例如“#RRGGBB”。

heroImageUri

string

可选。显示在优惠类正面的横幅图片。

redemptionChannel

enum (RedemptionChannel)

可选。优惠类的兑换渠道。

classTemplateInfo

object (ClassTemplateInfo)

可选。有关应如何显示优惠类的模板信息。

EventTicketClass

JSON 表示法
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "logoUri": string,
  "eventName": {
    object (LocalizedString)
  },
  "venue": {
    object (EventVenue)
  },
  "dateTime": {
    object (EventDateTime)
  },
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
字段
id

string

可选。活动门票类的 ID。

issuerName

string

可选。活动门票类的发卡机构名称。

localizedIssuerName

object (LocalizedString)

可选。活动门票类的本地化发卡机构名称。

logoUri

string

可选。活动门票类的徽标。

eventName

object (LocalizedString)

可选。事件名称。

venue

object (EventVenue)

可选。活动的场地。

dateTime

object (EventDateTime)

可选。活动日期和时间的相关信息。

hexBackgroundColor

string

可选。活动门票类别的背景颜色。格式为十六进制颜色字符串,例如“#RRGGBB”。

heroImageUri

string

可选。显示在活动门票类正面的横幅图片。

classTemplateInfo

object (ClassTemplateInfo)

可选。有关应如何显示活动门票类的模板信息。

EventVenue

JSON 表示法
{
  "name": {
    object (LocalizedString)
  },
  "address": {
    object (LocalizedString)
  }
}
字段
name

object (LocalizedString)

可选。场所的名称。

address

object (LocalizedString)

可选。营业地点的地址。

EventDateTime

JSON 表示法
{
  "start": string,
  "end": string
}
字段
start

string

可选。活动的开始日期/时间。如果活动持续数天,则应为第一天的开始日期/时间。格式为 ISO 8601 扩展格式的日期/时间,不带偏移量,时间可以指定精确到毫秒,例如 2027-03-05T06:30:00。

end

string

可选。活动的结束日期/时间。如果活动持续数天,则应是活动最后一天的结束日期/时间。格式为 ISO 8601 扩展格式的日期/时间,不带偏移量,时间可以指定精确到毫秒,例如 2027-03-05T06:30:00。

FlightClass

JSON 表示法
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "flightHeader": {
    object (FlightHeader)
  },
  "origin": {
    object (AirportInfo)
  },
  "destination": {
    object (AirportInfo)
  },
  "localScheduledDepartureDateTime": string,
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
字段
id

string

可选。航班舱位的 ID。

issuerName

string

可选。机票舱位的发行方名称。

localizedIssuerName

object (LocalizedString)

可选。机票舱位的本地化发行方名称。

flightHeader

object (FlightHeader)

可选。关于航空公司和航班号的信息。

origin

object (AirportInfo)

可选。出发地机场的相关信息。

destination

object (AirportInfo)

可选。目的地机场的相关信息。

localScheduledDepartureDateTime

string

可选。飞机离开登机口(而不是跑道)的预定日期和时间。格式为 ISO 8601 扩展格式的日期/时间,不带偏移量,时间可以精确到毫秒,例如 2027-03-05T06:30:00。此时间应该是机场的当地日期/时间(不是世界协调时间 [UTC])。

hexBackgroundColor

string

可选。机票舱位的背景颜色。格式为十六进制颜色字符串,例如“#RRGGBB”。

heroImageUri

string

可选。显示在航班舱位正面的横幅图片。

classTemplateInfo

object (ClassTemplateInfo)

可选。有关应如何显示航班舱位的模板信息。

FlightHeader

JSON 表示法
{
  "carrier": {
    object (FlightCarrier)
  },
  "flightNumber": string
}
字段
carrier

object (FlightCarrier)

可选。有关航空公司的信息。

flightNumber

string

可选。不含航空公司 IATA 代码的航班号。相应字段仅包含数字,例如“123”。

FlightCarrier

JSON 表示法
{
  "carrierIataCode": string,
  "carrierIcaoCode": string,
  "airlineLogoUri": string
}
字段
carrierIataCode

string

可选。航空公司的 IATA 代码(2 个字符)。

carrierIcaoCode

string

可选。承运航空公司的 ICAO 航空公司代码(3 个字符)。

airlineLogoUri

string

可选。由承运航空公司 IATA 代码描述的航空公司的徽标。

AirportInfo

JSON 表示法
{
  "airportIataCode": string,
  "terminal": string,
  "gate": string
}
字段
airportIataCode

string

可选。IATA 机场代码(3 个字符),例如“SFO”。

terminal

string

可选。航站楼名称,例如“I”。

gate

string

可选。登机口名称,例如“B59”。

TransitClass

JSON 表示法
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "transitType": enum (TransitType),
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
字段
id

string

可选。公交类的 ID。

issuerName

string

可选。公交卡类的发行方名称。

localizedIssuerName

object (LocalizedString)

可选。公交卡类的本地化发行方名称。

hexBackgroundColor

string

可选。公交类别的背景颜色。格式为十六进制颜色字符串,例如“#RRGGBB”。

heroImageUri

string

可选。显示在公交类正面的横幅图片。

transitType

enum (TransitType)

可选。公交类别的公交类型。

classTemplateInfo

object (ClassTemplateInfo)

可选。有关应如何显示公交类别的模板信息。

GenericClass

JSON 表示法
{
  "id": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
字段
id

string

可选。通用类的 ID。

classTemplateInfo

object (ClassTemplateInfo)

可选。有关应如何显示泛型类的模板信息。

工具注释

破坏性提示:❌ | 等幂性提示:✅ | 只读提示:✅ | 开放世界提示:❌