Índice
LoyaltyClassService
(interface)LoyaltyObjectService
(interface)LoyaltyClass
(mensagem)LoyaltyClassAddMessageRequest
(mensagem)LoyaltyClassAddMessageResponse
(mensagem)LoyaltyClassGetRequest
(mensagem)LoyaltyClassInsertRequest
(mensagem)LoyaltyClassListRequest
(mensagem)LoyaltyClassListResponse
(mensagem)LoyaltyClassPatchRequest
(mensagem)LoyaltyClassUpdateRequest
(mensagem)LoyaltyObject
(mensagem)LoyaltyObjectAddMessageRequest
(mensagem)LoyaltyObjectAddMessageResponse
(mensagem)LoyaltyObjectGetRequest
(mensagem)LoyaltyObjectInsertRequest
(mensagem)LoyaltyObjectListRequest
(mensagem)LoyaltyObjectListResponse
(mensagem)LoyaltyObjectModifyLinkedOfferObjectsRequest
(mensagem)LoyaltyObjectPatchRequest
(mensagem)LoyaltyObjectUpdateRequest
(mensagem)LoyaltyPoints
(mensagem)LoyaltyPointsBalance
(mensagem)
LoyaltyClassService
AddMessage | |
---|---|
Adiciona uma mensagem à classe de fidelidade indicada pelo código de classe fornecido.
|
Get | |
---|---|
Retorna a classe de fidelidade com o código de classe fornecido.
|
Insert | |
---|---|
Insere uma classe de fidelidade com o código e as propriedades fornecidos.
|
List | |
---|---|
Retorna uma lista de todas as classes de fidelidade de um determinado código de emissor.
|
Patch | |
---|---|
Atualiza a classe de fidelidade indicada pelo código de classe fornecido. Este método é compatível com a semântica de patch.
|
Update | |
---|---|
Atualiza a classe de fidelidade indicada pelo código de classe fornecido.
|
LoyaltyObjectService
AddMessage | |
---|---|
Adiciona uma mensagem ao objeto de fidelidade indicado pelo código de objeto fornecido.
|
Get | |
---|---|
Retorna o objeto de fidelidade com o código de objeto fornecido.
|
Insert | |
---|---|
Insere um objeto de fidelidade com o código e as propriedades fornecidos.
|
List | |
---|---|
Retorna uma lista de todos os objetos de fidelidade de um determinado código de emissor.
|
ModifyLinkedOfferObjects | |
---|---|
Modifica objetos de oferta vinculados do objeto de fidelidade com o código fornecido.
|
Patch | |
---|---|
Atualiza o objeto de fidelidade indicado pelo código de objeto fornecido. Este método é compatível com a semântica de patch.
|
Update | |
---|---|
Atualiza o objeto de fidelidade indicado pelo código de objeto fornecido.
|
LoyaltyClass
Campos | |
---|---|
kind |
Identifica o tipo de recurso. Valor: a string fixa |
program_name |
Obrigatório. O nome do programa, 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 |
Obrigatório. O logotipo do programa de fidelidade ou empresa. Este logotipo é exibido nas visualizações em detalhes e em lista do app. |
account_name_label |
O rótulo do nome da conta, como "Nome do membro". O tamanho máximo recomendado é 15 caracteres para garantir que a string inteira seja exibida em telas menores. |
account_id_label |
O rótulo do código da conta, como "código do membro". O tamanho máximo recomendado é 15 caracteres para garantir que a string inteira seja exibida em telas menores. |
rewards_tier_label |
O rótulo do nível de recompensas, como "Nível de recompensas". O tamanho máximo recomendado é 9 caracteres para garantir que a string inteira seja exibida em telas menores. |
rewards_tier |
O nível de recompensas, como "Ouro" ou "Platinum". O tamanho máximo recomendado é 7 caracteres para garantir que a string inteira seja exibida em telas menores. |
localized_program_name |
Strings traduzidas do program_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_account_name_label |
Strings traduzidas do account_name_label. O comprimento máximo recomendado é 15 caracteres, para garantir que a string inteira seja exibida em telas menores. |
localized_account_id_label |
Strings traduzidas do account_id_label. O comprimento máximo recomendado é 15 caracteres, para garantir que a string inteira seja exibida em telas menores. |
localized_rewards_tier_label |
Strings traduzidas do rewards_tier_label. O comprimento máximo recomendado é 9 caracteres, para garantir que a string inteira seja exibida em telas menores. |
localized_rewards_tier |
Strings traduzidas do rewards_tier. O comprimento máximo recomendado é 7 caracteres, para garantir que a string inteira seja exibida em telas menores. |
secondary_rewards_tier_label |
O rótulo do nível secundário de prêmios, como "Nível de prêmios". |
localized_secondary_rewards_tier_label |
Strings traduzidas do secondary_rewards_tier_label. |
secondary_rewards_tier |
O nível secundário de recompensas, como "Ouro" ou "Platinum". |
localized_secondary_rewards_tier |
Strings traduzidas do secondary_rewards_tier. |
discoverable_program |
Informações sobre como a classe pode ser descoberta e instanciada no app Google Pay. |
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. |
LoyaltyClassAddMessageRequest
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. |
LoyaltyClassAddMessageResponse
Campos | |
---|---|
resource |
O recurso LoyaltyClass atualizado. |
LoyaltyClassGetRequest
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 "-". |
LoyaltyClassInsertRequest
Campos | |
---|---|
resource |
Corpo da solicitação. |
LoyaltyClassListRequest
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 |
LoyaltyClassListResponse
Campos | |
---|---|
resources[] |
Recursos correspondentes à solicitação de lista. |
pagination |
Paginação da resposta. |
LoyaltyClassPatchRequest
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. |
LoyaltyClassUpdateRequest
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. |
LoyaltyObject
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. |
account_name |
O nome do titular da conta de fidelidade, como "John Smith". O comprimento máximo recomendado é 20 caracteres, para garantir que a string inteira seja exibida em telas menores. |
account_id |
O identificador da conta de fidelidade. O comprimento máximo recomendado é 20 caracteres. |
loyalty_points |
Rótulo, saldo e tipo de pontos de prêmios do programa de fidelidade. |
linked_offer_ids[] |
Uma lista de objetos de oferta vinculados a este cartão de fidelidade. É preciso que os objetos de oferta já existam. Os IDs de objeto da oferta precisam seguir o formato issuer ID.identifier, em que o primeiro é emitido pelo Google e o último é escolhido por você. |
secondary_loyalty_points |
Rótulo, saldo e tipo de pontos de prêmios por fidelidade secundários. Mostrado além dos pontos de fidelidade principais. |
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. |
LoyaltyObjectAddMessageRequest
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. |
LoyaltyObjectAddMessageResponse
Campos | |
---|---|
resource |
O recurso LoyaltyObject atualizado. |
LoyaltyObjectGetRequest
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 "-". |
LoyaltyObjectInsertRequest
Campos | |
---|---|
resource |
Corpo da solicitação. |
LoyaltyObjectListRequest
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 |
LoyaltyObjectListResponse
Campos | |
---|---|
resources[] |
Recursos correspondentes à solicitação de lista. |
pagination |
Paginação da resposta. |
LoyaltyObjectModifyLinkedOfferObjectsRequest
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 "-". |
modify_linked_offer_objects_request |
Os IDs de objeto de oferta referentes ao objeto de fidelidade. |
LoyaltyObjectPatchRequest
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. |
LoyaltyObjectUpdateRequest
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. |
LoyaltyPoints
Campos | |
---|---|
label |
O rótulo de pontos de fidelidade, como "Pontos". O comprimento máximo recomendado é 9 caracteres. |
balance |
O saldo dos pontos de fidelidade do titular da conta, como "500" ou "US$ 10,00". O tamanho máximo recomendado é 7 caracteres. Este é um campo obrigatório de |
localized_label |
Strings traduzidas do rótulo. O comprimento máximo recomendado é 9 caracteres. |
LoyaltyPointsBalance
Campos | |
---|---|
string |
O formato de string de um saldo. Somente um desses subtipos (string, int, double, money) deve ser preenchido. |
int |
A forma do número inteiro de um saldo. Somente um desses subtipos (string, int, double, money) deve ser preenchido. |
double |
A forma dupla de um saldo. Somente um desses subtipos (string, int, double, money) deve ser preenchido. |
money |
A forma monetária de um saldo. Somente um desses subtipos (string, int, double, money) deve ser preenchido. |