MCP Tools Reference: paydeveloper.googleapis.com

Ferramenta: list_pass_classes

Recupera uma lista abrangente de todas as classes de cartão registradas no console empresarial da Carteira do Google associado ao usuário autenticado. Essa ferramenta fornece informações essenciais para desenvolvedores que gerenciam cartões da Carteira, como cartões de fidelidade, vales-presente ou voos.

O exemplo a seguir demonstra como usar curl para invocar a ferramenta list_pass_classes MCP.

Solicitação 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
}'

Esquema de entrada

Mensagem de solicitação para listar classes de passes de um emissor.

ListPassClassesRequest

Representação JSON 
{
  "issuerId": string,
  "passType": enum (PassType),
  "view": enum (PassClassView)
}
Campos
issuerId

string (int64 format)

Obrigatório. O identificador exclusivo do emissor para listar classes de cartão.
passType

enum (PassType)

Opcional. O tipo de classe de cartão a ser listada. Se não for especificado, todos os tipos de classes de cartão serão retornados.
view

enum (PassClassView)

Opcional. Especifica o nível de detalhes a serem retornados para cada classe de cartão.

Esquema de saída

Mensagem de resposta para listar classes de passes de um emissor.

ListPassClassesResponse

Representação JSON 
{
  "passClasses": [
    {
      object (PassClass)
    }
  ]
}
Campos
passClasses[]

object (PassClass)

As classes de cartão do emissor.

PassClass

Representação 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.
}
Campos

Campo de união resource.

resource pode ser apenas de um dos tipos a seguir:
loyaltyClass

object (LoyaltyClass)

Opcional. A classe de fidelidade do emissor.
giftCardClass

object (GiftCardClass)

Opcional. A classe de vale-presente do emissor.
offerClass

object (OfferClass)

Opcional. A classe de oferta do emissor.
eventTicketClass

object (EventTicketClass)

Opcional. A classe do ingresso de um evento do emissor.
flightClass

object (FlightClass)

Opcional. A classe de voo do emissor.
transitClass

object (TransitClass)

Opcional. A classe de transporte do emissor.
genericClass

object (GenericClass)

Opcional. A classe genérica do emissor.

LoyaltyClass

Representação 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)
  }
}
Campos
id

string

Opcional. O ID da classe de fidelidade.
issuerName

string

Opcional. O nome do emissor da classe de fidelidade.
localizedIssuerName

object (LocalizedString)

Opcional. O nome localizado do emissor da classe de fidelidade.
programName

string

Opcional. O nome do programa da classe de fidelidade.
localizedProgramName

object (LocalizedString)

Opcional. O nome do programa localizado da classe de fidelidade.
programLogoUri

string

Opcional. O logotipo do programa da classe de fidelidade.
hexBackgroundColor

string

Opcional. A cor de fundo da classe de fidelidade. O formato é uma string de cor hexadecimal, por exemplo, "#RRGGBB".
heroImageUri

string

Opcional. A imagem do banner exibida na frente da classe de fidelidade.
discoverableProgram

object (DiscoverableProgram)

Opcional. Informações sobre como a classe de fidelidade pode ser descoberta e instanciada na Carteira do Google.
classTemplateInfo

object (ClassTemplateInfo)

Opcional. As informações de modelo sobre como a classe de fidelidade deve ser exibida.

LocalizedString

Representação JSON 
{
  "translatedValues": [
    {
      object (TranslatedString)
    }
  ],
  "defaultValue": {
    object (TranslatedString)
  }
}
Campos
translatedValues[]

object (TranslatedString)

Opcional. As strings traduzidas da string.
defaultValue

object (TranslatedString)

Opcional. A string a ser exibida caso não haja tradução apropriada disponível.

TranslatedString

Representação JSON 
{
  "languageCode": string,
  "value": string
}
Campos
languageCode

string

Opcional. A tag de idioma BCP 47. Valores de exemplo: "en-US", "en-GB", "de" ou "de-AT".
value

string

Opcional. A string traduzida codificada em UTF-8.

DiscoverableProgram

Representação JSON 
{
  "merchantSignupInfo": {
    object (MerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (MerchantSigninInfo)
  },
  "state": enum (State)
}
Campos
merchantSignupInfo

object (MerchantSignupInfo)

Opcional. Informações sobre a capacidade de se inscrever e adicionar itens valiosos a este programa detectável por meio de um site comercial.
merchantSigninInfo

object (MerchantSigninInfo)

Opcional. Informações sobre a capacidade de fazer login e adicionar algo valioso a este programa detectável por meio de um site comercial.
state

enum (State)

Apenas saída. O estado do programa detectável.

MerchantSignupInfo

Representação JSON 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Campos
signupWebsite

object (Uri)

Opcional. O site para se inscrever no programa detectável.
signupSharedDatas[]

enum (SharedDataType)

Opcional. Os dados do usuário enviados em uma solicitação POST ao URL do site de inscrição. Essas informações são codificadas e compartilhadas para que o site do comerciante preencha previamente os campos usados para registrar o usuário no programa detectável.

URI

Representação JSON 
{
  "uri": string,
  "description": string,
  "localizedDescription": {
    object (LocalizedString)
  }
}
Campos
uri

string

Opcional. O URI.
description

string

Opcional. O título do URI que aparece na Carteira do Google como texto.
localizedDescription

object (LocalizedString)

Opcional. As strings traduzidas do título do URI que aparecem na Carteira do Google como texto.

MerchantSigninInfo

Representação JSON 
{
  "signinWebsite": {
    object (Uri)
  }
}
Campos
signinWebsite

object (Uri)

Opcional. O site para fazer login no programa detectável.

ClassTemplateInfo

Representação JSON 
{
  "cardBarcodeSectionDetails": {
    object (CardBarcodeSectionDetails)
  },
  "cardTemplateOverride": {
    object (CardTemplateOverride)
  },
  "detailsTemplateOverride": {
    object (DetailsTemplateOverride)
  },
  "listTemplateOverride": {
    object (ListTemplateOverride)
  }
}
Campos
cardBarcodeSectionDetails

object (CardBarcodeSectionDetails)

Opcional. As informações extras a serem exibidas acima e abaixo do código de barras.
cardTemplateOverride

object (CardTemplateOverride)

Opcional. A substituição do modelo para a visualização de card.
detailsTemplateOverride

object (DetailsTemplateOverride)

Opcional. A substituição de modelo para a visualização de detalhes.
listTemplateOverride

object (ListTemplateOverride)

Opcional. A substituição de modelo para a visualização da lista de cartões.

CardBarcodeSectionDetails

Representação JSON 
{
  "firstTopDetail": {
    object (BarcodeSectionDetail)
  },
  "firstBottomDetail": {
    object (BarcodeSectionDetail)
  },
  "secondTopDetail": {
    object (BarcodeSectionDetail)
  }
}
Campos
firstTopDetail

object (BarcodeSectionDetail)

Opcional. As informações opcionais a serem exibidas acima do código de barras. Se secondTopDetail estiver definido, isso será exibido no começo da seção de detalhes.
firstBottomDetail

object (BarcodeSectionDetail)

Opcional. As informações opcionais que serão exibidas abaixo do código de barras.
secondTopDetail

object (BarcodeSectionDetail)

Opcional. A segunda informação opcional que será exibida acima do código de barras. Se firstTopDetail estiver definido, isso será exibido no final da seção de detalhes.

BarcodeSectionDetail

Representação JSON 
{
  "fieldSelector": {
    object (FieldSelector)
  }
}
Campos
fieldSelector

object (FieldSelector)

Opcional. A referência a um campo de imagem ou texto atual a ser exibido.

FieldSelector

Representação JSON 
{
  "fields": [
    {
      object (FieldReference)
    }
  ]
}
Campos
fields[]

object (FieldReference)

Opcional. As referências de campo a serem usadas com substituições de campo. Se mais de uma referência tiver sido informada, será exibida a primeira que referenciar um campo não vazio.

FieldReference

Representação JSON 
{
  "fieldPath": string,
  "dateFormat": enum (DateFormat)
}
Campos
fieldPath

string

Opcional. O caminho para o campo que está sendo referenciado, com o prefixo "object" ou "class" e separado por pontos.
dateFormat

enum (DateFormat)

Opcional. O formato de data para renderizar campos de data/hora.

CardTemplateOverride

Representação JSON 
{
  "cardRowTemplateInfos": [
    {
      object (CardRowTemplateInfo)
    }
  ]
}
Campos
cardRowTemplateInfos[]

object (CardRowTemplateInfo)

Opcional. Informações do modelo sobre linhas na visualização de card. É possível especificar três linhas no máximo.

CardRowTemplateInfo

Representação 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.
}
Campos
Campo de união row_template. O modelo de uma linha com um, dois ou três itens. row_template pode ser apenas de um dos tipos a seguir:
oneItem

object (CardRowOneItem)

Opcional. O modelo de uma linha com um item.
twoItems

object (CardRowTwoItems)

Opcional. Modelo de uma linha com dois itens.
threeItems

object (CardRowThreeItems)

Opcional. Modelo de uma linha com três itens.

CardRowOneItem

Representação JSON 
{
  "item": {
    object (TemplateItem)
  }
}
Campos
item

object (TemplateItem)

Opcional. O item a ser exibido na linha. Esse item será centralizado.

TemplateItem

Representação JSON 
{
  "firstValue": {
    object (FieldSelector)
  },
  "secondValue": {
    object (FieldSelector)
  },
  "predefinedItem": enum (PredefinedItem)
}
Campos
firstValue

object (FieldSelector)

Opcional. A referência ao primeiro campo a ser exibido.
secondValue

object (FieldSelector)

Opcional. A referência ao segundo campo a ser exibido.
predefinedItem

enum (PredefinedItem)

Opcional. O item predefinido a ser exibido.

CardRowTwoItems

Representação JSON 
{
  "startItem": {
    object (TemplateItem)
  },
  "endItem": {
    object (TemplateItem)
  }
}
Campos
startItem

object (TemplateItem)

Opcional. O item a ser exibido no início da linha. Esse item será alinhado à esquerda.
endItem

object (TemplateItem)

Opcional. O item a ser exibido no final da linha. Esse item será alinhado à direita.

CardRowThreeItems

Representação JSON 
{
  "startItem": {
    object (TemplateItem)
  },
  "middleItem": {
    object (TemplateItem)
  },
  "endItem": {
    object (TemplateItem)
  }
}
Campos
startItem

object (TemplateItem)

Opcional. O item a ser exibido no início da linha. Esse item será alinhado à esquerda.
middleItem

object (TemplateItem)

Opcional. O item a ser exibido no meio da linha. Esse item será centralizado entre o primeiro e o último item.
endItem

object (TemplateItem)

Opcional. O item a ser exibido no final da linha. Esse item será alinhado à direita.

DetailsTemplateOverride

Representação JSON 
{
  "detailsItemInfos": [
    {
      object (DetailsItemInfo)
    }
  ]
}
Campos
detailsItemInfos[]

object (DetailsItemInfo)

Opcional. As informações do modelo sobre os itens mostrados na lista de detalhes.

DetailsItemInfo

Representação JSON 
{
  "item": {
    object (TemplateItem)
  }
}
Campos
item

object (TemplateItem)

Opcional. O item a ser exibido na lista de detalhes.

ListTemplateOverride

Representação JSON 
{
  "firstRowOption": {
    object (FirstRowOption)
  },
  "secondRowOption": {
    object (FieldSelector)
  }
}
Campos
firstRowOption

object (FirstRowOption)

Opcional. A referência ao campo a ser exibido na primeira linha.
secondRowOption

object (FieldSelector)

Opcional. A referência ao campo a ser exibido na segunda linha.

FirstRowOption

Representação JSON 
{
  "transitOption": enum (TransitOption),
  "fieldOption": {
    object (FieldSelector)
  }
}
Campos
transitOption

enum (TransitOption)

Opcional. A opção de transporte público a ser exibida na primeira linha.
fieldOption

object (FieldSelector)

Opcional. A referência ao campo a ser exibido na primeira linha.

GiftCardClass

Representação 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)
  }
}
Campos
id

string

Opcional. O ID da classe de vale-presente.
issuerName

string

Opcional. O nome do emissor da classe de vale-presente.
localizedIssuerName

object (LocalizedString)

Opcional. O nome localizado do emissor da classe de vale-presente.
merchantName

string

Opcional. O nome do comerciante da classe de vale-presente.
localizedMerchantName

object (LocalizedString)

Opcional. O nome localizado do comerciante da classe de vale-presente.
programLogoUri

string

Opcional. O logotipo do programa da classe de vale-presente.
hexBackgroundColor

string

Opcional. A cor de fundo da classe de vale-presente. O formato é uma string de cor hexadecimal, por exemplo, "#RRGGBB".
heroImageUri

string

Opcional. A imagem do banner exibida na frente da classe de vale-presente.
homePageUri

object (Uri)

Opcional. O site da página inicial do aplicativo.
classTemplateInfo

object (ClassTemplateInfo)

Opcional. As informações de modelo sobre como a classe de vale-presente deve ser exibida.

OfferClass

Representação 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)
  }
}
Campos
id

string

Opcional. O ID da classe de oferta.
issuerName

string

Opcional. O nome do emissor da classe de oferta.
localizedIssuerName

object (LocalizedString)

Opcional. O nome localizado do emissor da classe de oferta.
provider

string

Opcional. O provedor da classe de oferta.
localizedProvider

object (LocalizedString)

Opcional. O provedor localizado da classe de oferta.
title

string

Opcional. O título da classe de oferta.
localizedTitle

object (LocalizedString)

Opcional. O título localizado da classe de oferta.
titleImageUri

string

Opcional. A imagem do título da classe de oferta.
hexBackgroundColor

string

Opcional. A cor de fundo da classe de oferta. O formato é uma string de cor hexadecimal, por exemplo, "#RRGGBB".
heroImageUri

string

Opcional. A imagem do banner exibida na frente da classe de oferta.
redemptionChannel

enum (RedemptionChannel)

Opcional. O canal de resgate da classe de oferta.
classTemplateInfo

object (ClassTemplateInfo)

Opcional. As informações de modelo sobre como a classe de oferta deve ser exibida.

EventTicketClass

Representação 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)
  }
}
Campos
id

string

Opcional. O ID da classe de ingresso de um evento.
issuerName

string

Opcional. O nome do emissor da classe de ingresso de um evento.
localizedIssuerName

object (LocalizedString)

Opcional. O nome localizado do emissor da classe de ingresso de um evento.
logoUri

string

Opcional. O logotipo da classe de ingresso de um evento.
eventName

object (LocalizedString)

Opcional. O nome do evento.
venue

object (EventVenue)

Opcional. O local do evento.
dateTime

object (EventDateTime)

Opcional. As informações sobre a data e a hora do evento.
hexBackgroundColor

string

Opcional. A cor de fundo da classe do ingresso de um evento. O formato é uma string de cor hexadecimal, por exemplo, "#RRGGBB".
heroImageUri

string

Opcional. A imagem do banner exibida na frente da classe do ingresso de um evento.
classTemplateInfo

object (ClassTemplateInfo)

Opcional. As informações de modelo sobre como a classe de ingresso de um evento deve ser exibida.

EventVenue

Representação JSON 
{
  "name": {
    object (LocalizedString)
  },
  "address": {
    object (LocalizedString)
  }
}
Campos
name

object (LocalizedString)

Opcional. O nome do local.
address

object (LocalizedString)

Opcional. O endereço do local.

EventDateTime

Representação JSON 
{
  "start": string,
  "end": string
}
Campos
start

string

Opcional. A data/hora em que o evento começa. Se o evento se estender por vários dias, deverá ser a data/hora de início no primeiro dia. O formato é uma data/hora em formato estendido ISO 8601 sem compensação, e o horário pode ser especificado com precisão de milissegundos, por exemplo, 2027-03-05T06:30:00.
end

string

Opcional. A data/hora em que o evento termina. Se o evento se estender por vários dias, deverá ser a data/hora de término no último dia. O formato é uma data/hora em formato estendido ISO 8601 sem compensação, e o horário pode ser especificado com precisão de milissegundos, por exemplo, 2027-03-05T06:30:00.

FlightClass

Representação 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)
  }
}
Campos
id

string

Opcional. O ID da classe de voo.
issuerName

string

Opcional. O nome do emissor da classe de voo.
localizedIssuerName

object (LocalizedString)

Opcional. O nome localizado do emissor da classe de voo.
flightHeader

object (FlightHeader)

Opcional. Informações sobre a transportadora aérea e o número.
origin

object (AirportInfo)

Opcional. As informações sobre o aeroporto de origem.
destination

object (AirportInfo)

Opcional. As informações sobre o aeroporto de destino.
localScheduledDepartureDateTime

string

Opcional. Data e hora programadas para a partida da aeronave do portão (não da pista). O formato é uma data/hora em formato estendido ISO 8601 sem compensação, e o horário pode ser especificado com precisão de milissegundos, por exemplo, 2027-03-05T06:30:00. Precisa ser a data/hora local no aeroporto (não um horário UTC).
hexBackgroundColor

string

Opcional. A cor de fundo da classe do voo. O formato é uma string de cor hexadecimal, por exemplo, "#RRGGBB".
heroImageUri

string

Opcional. A imagem do banner exibida na frente da classe de voo.
classTemplateInfo

object (ClassTemplateInfo)

Opcional. As informações de modelo sobre como a classe de voo deve ser exibida.

FlightHeader

Representação JSON 
{
  "carrier": {
    object (FlightCarrier)
  },
  "flightNumber": string
}
Campos
carrier

object (FlightCarrier)

Opcional. As informações sobre a transportadora aérea.
flightNumber

string

Opcional. O número do voo sem o código IATA da transportadora. O campo contém apenas dígitos, por exemplo, "123".

FlightCarrier

Representação JSON 
{
  "carrierIataCode": string,
  "carrierIcaoCode": string,
  "airlineLogoUri": string
}
Campos
carrierIataCode

string

Opcional. O código IATA da transportadora, com dois caracteres.
carrierIcaoCode

string

Opcional. O código ICAO de três caracteres da companhia aérea.
airlineLogoUri

string

Opcional. O logotipo da companhia aérea descrito pelo código IATA da transportadora.

AirportInfo

Representação JSON 
{
  "airportIataCode": string,
  "terminal": string,
  "gate": string
}
Campos
airportIataCode

string

Opcional. O código IATA do aeroporto com três caracteres, por exemplo, "SFO".
terminal

string

Opcional. O nome do terminal, por exemplo, "I".
gate

string

Opcional. O nome do portão, por exemplo, "B59".

TransitClass

Representação JSON 
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "transitType": enum (TransitType),
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
Campos
id

string

Opcional. O ID da classe de transporte público.
issuerName

string

Opcional. O nome do emissor da classe de trânsito.
localizedIssuerName

object (LocalizedString)

Opcional. O nome localizado do emissor da classe de trânsito.
hexBackgroundColor

string

Opcional. A cor de fundo da classe de trânsito. O formato é uma string de cor hexadecimal, por exemplo, "#RRGGBB".
heroImageUri

string

Opcional. A imagem do banner exibida na frente da classe de trânsito.
transitType

enum (TransitType)

Opcional. O tipo de transporte público da classe de transporte público.
classTemplateInfo

object (ClassTemplateInfo)

Opcional. As informações de modelo sobre como a classe de transporte público deve ser exibida.

GenericClass

Representação JSON 
{
  "id": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
Campos
id

string

Opcional. O ID da classe genérica.
classTemplateInfo

object (ClassTemplateInfo)

Opcional. As informações de modelo sobre como a classe genérica deve ser exibida.

Anotações de ferramentas

Dica destrutiva: ❌ | Dica idempotente: ✅ | Dica somente leitura: ✅ | Dica de mundo aberto: ❌