Gerenciar configurações de finalização da compra

O recurso Comprar Agora acelera a compra para clientes que já se decidiram, permitindo que eles acessem a página de finalização da compra ou o carrinho do seu site diretamente pelas informações de produtos do Google. Isso pode melhorar as taxas de conversão e facilitar a experiência de compra.

Com a API Merchant, é possível gerenciar as configurações desse recurso usando o recurso CheckoutSettings.

Este guia explica como usar a API Merchant para criar e gerenciar sua inscrição no recurso Comprar Agora de forma programática.

Para mais informações, consulte Adicionar um link de finalização de compra aos seus produtos.

Pré-requisitos

Para usar o recurso CheckoutSettings e os métodos associados, faça o seguinte:

  • Você precisa ter a aprovação e participar dos anúncios do Shopping, das listagens sem custo financeiro ou de ambos.
  • Seu país de vendas precisa ser os Estados Unidos.

Métodos

Para criar, recuperar, atualizar e excluir as configurações de finalização de compra, use os seguintes métodos:

Criar configurações de finalização de compra

Para criar uma configuração de finalização de compra, use o método checkoutSettings.create. Inclua uri_settings com checkout_uri_template ou cart_uri_template e os eligible_destinations selecionados no corpo da solicitação.

Confira um exemplo de solicitação:

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings

{
  "uri_settings": {
    "checkout_uri_template": "https://www.your-store.com/checkout?item_id={id}"
  },
  "eligible_destinations": [
    "FREE_LISTINGS",
    "SHOPPING_ADS"
  ]
}

Substitua {ACCOUNT_ID} pelo identificador exclusivo da sua conta do Merchant Center.

Confira um exemplo de resposta de uma chamada bem-sucedida:

{
  "name": "accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings",
  "uri_settings": {
    "checkout_uri_template": "https://www.your-store.com/checkout?item_id={id}"
  },
  "eligible_destinations": [
    "FREE_LISTINGS",
    "SHOPPING_ADS"
  ],
  "enrollment_state": "ENROLLED",
  "review_state": "IN_REVIEW",
  "effective_uri_settings": {
    "checkout_uri_template": "https://www.your-store.com/checkout?item_id={id}"
  },
  "effective_enrollment_state": "ENROLLED",
  "effective_review_state": "IN_REVIEW"
}

Recuperar configurações de finalização de compra

Para recuperar as configurações de finalização de compra, incluindo o modelo de URL, os destinos selecionados, o status da inscrição e o status da revisão do URL, use o método checkoutSettings.get.

Confira um exemplo de solicitação:

GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings

Confira um exemplo de resposta de uma chamada bem-sucedida:

{
  "name": "accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings",
  "uri_settings": {
    "checkout_uri_template": "https://www.your-store.com/checkout?item_id={id}"
  },
  "eligible_destinations": [
    "FREE_LISTINGS",
    "SHOPPING_ADS"
  ],
  "enrollment_state": "ENROLLED",
  "review_state": "APPROVED",
  "effective_uri_settings": {
    "checkout_uri_template": "https://www.your-store.com/checkout?item_id={id}"
  },
  "effective_enrollment_state": "ENROLLED",
  "effective_review_state": "APPROVED"
}

Atualizar configurações de finalização de compra

Para atualizar as configurações de finalização de compra, use o método checkoutSettings.update. Inclua os campos que você quer mudar no corpo da solicitação e especifique esses campos no parâmetro de consulta update_mask.

update_mask aceita os seguintes campos:

  • eligible_destinations
  • uri_settings

Confira um exemplo de solicitação que atualiza o URL e remove o destino dos anúncios:

PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings?update_mask=uri_settings,eligible_destinations

{
  "uri_settings": {
    "cart_uri_template": "https://shop.your-store.com/add_to_cart?sku={id}"
  },
  "eligible_destinations": [
    "FREE_LISTINGS"
  ]
}

Confira um exemplo de resposta de uma chamada bem-sucedida:

{
  "name": "accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings",
  "uri_settings": {
    "cart_uri_template": "https://shop.your-store.com/add_to_cart?sku={id}"
  },
  "eligible_destinations": [
    "FREE_LISTINGS"
  ],
  "enrollment_state": "ENROLLED",
  "review_state": "IN_REVIEW", // Review state will always be set to "IN_REVIEW" after URL update
  "effective_uri_settings": {
    "cart_uri_template": "https://shop.your-store.com/add_to_cart?sku={id}"
  },
  "effective_enrollment_state": "ENROLLED",
  "effective_review_state": "IN_REVIEW"
}

Excluir

Para excluir as configurações de finalização de compra, use o método checkoutSettings.delete.

Essa ação remove a configuração da sua conta, cancela sua inscrição no programa de finalização de compra e impede que os links de finalização de compra apareçam nos seus produtos em listagens sem custo financeiro e anúncios do Shopping.

Confira um exemplo de solicitação:

DELETE https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings

Uma chamada bem-sucedida retorna um corpo de resposta vazio.

Há duas maneiras de fornecer URLs de finalização de compra para seus produtos:

  • Nível da conta (sub-API ou Merchant Center): para definir um único modelo de URL, checkout_uri_template ou cart_uri_template, você pode usar as configurações da sub-API ou do Merchant Center. Esse modelo é aplicado a todos os seus produtos qualificados. Recomendamos que você tenha um URL consistente em todos os seus produtos. Por exemplo, yourstore.com/checkout?id={id}.

  • Nível do produto (feed) : para fornecer um URL de finalização de compra específico para produtos individuais, use o atributo checkout_link_template no feed de produtos. Isso permite URLs personalizados por produto ou oferece a finalização de compra apenas para um subconjunto do seu inventário.

  • Se você definir um modelo de URL no nível da conta usando essa sub-API, não envie valores para o atributo checkout_link_template no feed desses produtos.

  • Se você usar o atributo de feed checkout_link_template, não defina um modelo de URL no nível da conta usando as configurações da sub-API ou do Merchant Center. Você ainda pode usar a sub-API para selecionar os eligible_destinations sem fornecer uri_settings se estiver gerenciando URLs apenas pelo feed.

Modelo de URL de finalização de compra

O modelo de URL de finalização de compra permite incluir um URL de finalização de compra nos dados dos produtos. Isso permite que os clientes on-line acessem a página de finalização da compra diretamente pelas listagens. Ele precisa conter o marcador de posição do parâmetro {ID} e ter um domínio correspondente.

Ao configurar links de finalização de compra usando a sub-API, use o campo uri_settings. Esse campo aceita um dos dois modelos:

  • checkout_uri_template:um modelo de URL que, quando o marcador de posição é preenchido, direciona o usuário para a página de finalização da compra com o item específico pronto para compra.
  • cart_uri_template:um modelo de URL que direciona o usuário para a página do carrinho de compras com o item específico adicionado ao carrinho.

Exemplos de modelos

  • Finalização de compra:https://www.your-store.com/checkout?item_id={id}
  • Carrinho:https://shop.your-store.com/add_to_cart?product_sku={id}

Atenda aos seguintes requisitos:

  • O modelo de URL precisa apontar para uma página válida no seu site que corresponda ao domínio registrado, funcione usando o método HTTP GET e não exija que o cliente faça login.
  • O domínio do modelo de finalização de compra fornecido precisa corresponder ao domínio do produto.

Saiba mais