Índice
GiftCardClassService
(interface)GiftCardObjectService
(interface)GiftCardClass
(mensagem)GiftCardClassAddMessageRequest
(mensagem)GiftCardClassAddMessageResponse
(mensagem)GiftCardClassGetRequest
(mensagem)GiftCardClassInsertRequest
(mensagem)GiftCardClassListRequest
(mensagem)GiftCardClassListResponse
(mensagem)GiftCardClassPatchRequest
(mensagem)GiftCardClassUpdateRequest
(mensagem)GiftCardObject
(mensagem)GiftCardObjectAddMessageRequest
(mensagem)GiftCardObjectAddMessageResponse
(mensagem)GiftCardObjectGetRequest
(mensagem)GiftCardObjectInsertRequest
(mensagem)GiftCardObjectListRequest
(mensagem)GiftCardObjectListResponse
(mensagem)GiftCardObjectPatchRequest
(mensagem)GiftCardObjectUpdateRequest
(mensagem)
GiftCardClassService
AddMessage | |
---|---|
Adiciona uma mensagem à classe de vale-presente indicada pelo código de classe fornecido.
|
Get | |
---|---|
Retorna a classe do vale-presente com o código de classe fornecido.
|
Insert | |
---|---|
Insere uma classe de vale-presente com o código e as propriedades fornecidos.
|
List | |
---|---|
Retorna uma lista com todas as classes de vale-presente de um determinado código de emissor.
|
Patch | |
---|---|
Atualiza a classe de vale-presente indicada pelo código de classe fornecido. Este método é compatível com a semântica de patch.
|
Update | |
---|---|
Atualiza a classe de vale-presente indicada pelo código de classe fornecido.
|
GiftCardObjectService
AddMessage | |
---|---|
Adiciona uma mensagem ao objeto de vale-presente indicado pelo código de objeto fornecido.
|
Get | |
---|---|
Retorna o objeto de vale-presente com o código de objeto fornecido.
|
Insert | |
---|---|
Insere um objeto de vale-presente com o código e as propriedades fornecidos.
|
List | |
---|---|
Retorna uma lista de todos os objetos de vale-presente de um determinado código de emissor.
|
Patch | |
---|---|
Atualiza o objeto de vale-presente indicado pelo código de objeto fornecido. Este método é compatível com a semântica de patch.
|
Update | |
---|---|
Atualiza o objeto de vale-presente indicado pelo código de objeto fornecido.
|
GiftCardClass
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
merchant_name |
Nome do comerciante, como "Adam's Apparel". O app pode exibir reticências após os primeiros 20 caracteres para garantir que a string inteira seja exibida em telas menores. |
program_logo |
O logotipo do programa ou empresa do vale-presente. Este logotipo é exibido nos detalhes e nas visualizações de lista do app. |
pin_label |
O rótulo a ser exibido para o PIN, como "PIN de 4 dígitos". |
event_number_label |
O rótulo a ser exibido para o número do evento, como "Evento de destino nº". |
allow_barcode_redemption |
Determina se o comerciante aceita resgate de vale-presente usando código de barras. Se verdadeiro, o app exibirá um código de barras do vale-presente na tela de detalhes do vale-presente. Se falso, o código de barras não será exibido. |
localized_merchant_name |
Strings traduzidas do merchant_name. O app pode exibir reticências após os primeiros 20 caracteres para garantir que a string inteira seja exibida em telas menores. |
localized_pin_label |
Strings traduzidas do pin_label. |
localized_event_number_label |
Strings traduzidas do event_number_label. |
card_number_label |
O rótulo a ser exibido como número do cartão, como "Número do cartão". |
localized_card_number_label |
Strings traduzidas do card_number_label. |
class_template_info |
Informações de modelo sobre como a classe deve ser exibida. Se não estiver definido, o Google usará como alternativa um conjunto padrão de campos a serem exibidos. |
id |
Obrigatório. O identificador exclusivo de uma classe. Este ID precisa ser exclusivo entre todas as classes de um emissor. Esse valor precisa seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos: ".", "_" ou "-". |
version |
Obsoleto |
issuer_name |
Obrigatório. O nome do emissor. O tamanho máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores. |
messages[] |
Um conjunto de mensagens exibidas no app. Todos os usuários deste objeto receberão as mensagens associadas. O número máximo destes campos é 10. |
allow_multiple_users_per_object |
Obsoleto. Use |
homepage_uri |
O URI da página inicial do seu aplicativo. Preencher o URI neste campo resulta no mesmo comportamento que o preenchimento de um URI em linksModuleData: quando um objeto é renderizado, um link para a página inicial é mostrado no que normalmente seria considerada a seção linksModuleData do objeto. |
locations[] |
A lista de locais em que o objeto pode ser usado. A plataforma usa estas informações para acionar notificações de geolocalização para os usuários. Observe que os locais no objeto modificam os locais na classe, que por sua vez modificam os locais no ID do Google Places. |
review_status |
Obrigatório. O status da classe. Este campo pode ser definido como Você precisa manter esse campo como Quando acreditar que a classe está pronta para uso, defina este campo como Ao atualizar uma classe já |
review |
Os comentários de revisão definidos pela plataforma quando uma classe é marcada como |
info_module_data |
Obsoleto. Use textModulesData. |
image_modules_data[] |
Dados do módulo de imagem. O número máximo de campos exibidos é 1 no nível do objeto e 1 no nível do objeto da classe. |
text_modules_data[] |
Dados do módulo de texto. Se esses dados também estiverem definidos na classe, ambos serão exibidos. O número máximo de campos exibidos é 10 para o objeto e 10 para a classe. |
links_module_data |
Dados do módulo de links. Se os dados do módulo de links também estiverem definidos no objeto, ambos serão exibidos. |
redemption_issuers[] |
Disponível apenas para parceiros que aceitam smart tap. Entre em contato com o suporte para mais orientações. |
country_code |
ID do país, usado para exibir o país do cartão (quando o usuário não está nesse país), bem como para exibir o conteúdo localizado quando o conteúdo não está disponível na localidade do usuário |
hero_image |
Imagem de banner opcional exibida na frente do cartão. Se não houver nenhuma, nada será exibido. A imagem será exibida com 100% de largura. |
word_mark |
Obsoleto. |
enable_smart_tap |
Disponível apenas para parceiros que aceitam smart tap. Entre em contato com o suporte para mais orientações. |
hex_background_color |
A cor de fundo do cartão. Se não estiver definida, a cor predominante da imagem principal será usada. Se não houver nenhuma imagem principal definida, a cor predominante do logotipo será usada. O formato é #rrggbb, em que rrggbb é um trio hexadecimal RGB, como |
localized_issuer_name |
Strings traduzidas do issuer_name. O tamanho máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores. |
multiple_devices_and_holders_allowed_status |
Identifica se vários usuários e dispositivos salvarão o mesmo objeto que faz referência a esta classe. |
callback_options |
Opções de callback a serem usadas para retornar ao emissor em cada salvamento/exclusão de um objeto desta classe pelo usuário final. Todos os objetos desta classe são qualificados para callback. |
GiftCardClassAddMessageRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de uma classe. Este ID precisa ser exclusivo entre todas as classes de um emissor. Esse valor precisa seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos: ".", "_" ou "-". |
add_message_request |
Corpo da solicitação. |
GiftCardClassAddMessageResponse
Campos | |
---|---|
resource |
O recurso GiftCardClass atualizado. |
GiftCardClassGetRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de uma classe. Este ID precisa ser exclusivo entre todas as classes de um emissor. Esse valor precisa seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos: ".", "_" ou "-". |
GiftCardClassInsertRequest
Campos | |
---|---|
resource |
Corpo da solicitação. |
GiftCardClassListRequest
Campos | |
---|---|
issuer_id |
O ID do emissor autorizado a listar classes. |
token |
Usado para conseguir o próximo conjunto de resultados se |
max_results |
Identifica o número máximo de resultados retornados por uma lista. Todos os resultados serão retornados se |
GiftCardClassListResponse
Campos | |
---|---|
resources[] |
Recursos correspondentes à solicitação de lista. |
pagination |
Paginação da resposta. |
GiftCardClassPatchRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de uma classe. Este ID precisa ser exclusivo entre todas as classes de um emissor. Esse valor precisa seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos: ".", "_" ou "-". |
resource |
Corpo da solicitação. |
GiftCardClassUpdateRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de uma classe. Este ID precisa ser exclusivo entre todas as classes de um emissor. Esse valor precisa seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos: ".", "_" ou "-". |
resource |
Corpo da solicitação. |
GiftCardObject
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
class_reference |
Uma cópia dos campos herdados da classe pai. Estes campos são recuperados durante um GET. |
card_number |
Obrigatório. O número do cartão. |
pin |
O PIN do cartão. |
balance |
O saldo monetário do cartão. |
balance_update_time |
A data e hora em que o saldo foi atualizado pela última vez. A compensação é obrigatória. Se o saldo for atualizado e esta propriedade não for fornecida, o sistema assumirá o horário atual como padrão. |
event_number |
O número do evento do cartão, um campo opcional usado por alguns vales-presente. |
id |
Obrigatório. O identificador exclusivo de um objeto. Este ID precisa ser exclusivo entre todos os objetos de um emissor. Esse valor precisa seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos, ".", "_" ou "-". |
class_id |
Obrigatório. A classe associada a este objeto. É preciso que a classe seja do mesmo tipo que este objeto, já existente e aprovada. Os IDs de classe precisam seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. |
version |
Obsoleto |
state |
Obrigatório. O estado do objeto. Este campo é usado para determinar como um objeto é exibido no app. Por exemplo, um objeto |
barcode |
O tipo e o valor do código de barras. |
messages[] |
Um conjunto de mensagens exibidas no app. Todos os usuários deste objeto receberão as mensagens associadas. O número máximo destes campos é 10. |
valid_time_interval |
O período em que esse objeto fica |
locations[] |
A lista de locais em que o objeto pode ser usado. A plataforma usa estas informações para acionar notificações de geolocalização para os usuários. Observe que os locais no objeto modificam os locais na classe, que por sua vez modificam os locais no ID do Google Places. |
has_users |
Indica se o objeto tem usuários. Este campo é definido pela plataforma. |
smart_tap_redemption_value |
Disponível apenas para parceiros que aceitam smart tap. Entre em contato com o suporte para mais orientações. |
has_linked_device |
Se este objeto está atualmente vinculado a um único dispositivo. Este campo é definido pela plataforma quando um usuário salva o objeto, vinculando-o ao dispositivo. Destinado ao uso por parceiros selecionados. Entre em contato com o suporte para mais informações. |
disable_expiration_notification |
Indica se as notificações devem ser explicitamente suprimidas. Se esse campo estiver definido como verdadeiro, independentemente do campo Atualmente, só é possível definir isso para ofertas. |
info_module_data |
Obsoleto. Use textModulesData. |
image_modules_data[] |
Dados do módulo de imagem. O número máximo de campos exibidos é 1 no nível do objeto e 1 no nível do objeto da classe. |
text_modules_data[] |
Dados do módulo de texto. Se esses dados também estiverem definidos na classe, ambos serão exibidos. O número máximo de campos exibidos é 10 para o objeto e 10 para a classe. |
links_module_data |
Dados do módulo de links. Se os dados do módulo de links também estiverem definidos na classe, ambos serão exibidos. |
app_link_data |
Informações opcionais sobre o link do app do parceiro. |
GiftCardObjectAddMessageRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de um objeto. Este ID precisa ser exclusivo entre todos os objetos de um emissor. Esse valor precisa seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos: ".", "_" ou "-". |
add_message_request |
Corpo da solicitação. |
GiftCardObjectAddMessageResponse
Campos | |
---|---|
resource |
O recurso GiftCardObject atualizado. |
GiftCardObjectGetRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de um objeto. Este ID precisa ser exclusivo entre todos os objetos de um emissor. Esse valor precisa seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos: ".", "_" ou "-". |
GiftCardObjectInsertRequest
Campos | |
---|---|
resource |
Corpo da solicitação. |
GiftCardObjectListRequest
Campos | |
---|---|
class_id |
O ID da classe que terá objetos listados. |
token |
Usado para conseguir o próximo conjunto de resultados se |
max_results |
Identifica o número máximo de resultados retornados por uma lista. Todos os resultados serão retornados se |
GiftCardObjectListResponse
Campos | |
---|---|
resources[] |
Recursos correspondentes à solicitação de lista. |
pagination |
Paginação da resposta. |
GiftCardObjectPatchRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de um objeto. Este ID precisa ser exclusivo entre todos os objetos de um emissor. Esse valor precisa seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos: ".", "_" ou "-". |
resource |
Corpo da solicitação. |
GiftCardObjectUpdateRequest
Campos | |
---|---|
resource_id |
O identificador exclusivo de um objeto. Este ID precisa ser exclusivo entre todos os objetos de um emissor. Esse valor precisa seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. O identificador exclusivo deve incluir apenas caracteres alfanuméricos: ".", "_" ou "-". |
resource |
Corpo da solicitação. |