Administra la configuración de confirmación de la compra

La función de confirmación de compra acelera las compras de los clientes que están listos para comprar, ya que les permite ir directamente de las fichas de productos de Google al carrito o a la página de confirmación de compra de tu sitio web, lo que puede mejorar los porcentajes de conversión y suavizar la experiencia de compra.

Con la API de Merchant, puedes administrar la configuración de esta función con el recurso CheckoutSettings.

En esta guía, se explica cómo usar la API de Merchant para crear y administrar tu inscripción en la función de confirmación de la compra de manera programática.

Para obtener más información, consulta Agrega un vínculo de confirmación de compra a tus productos.

Requisitos previos

Para usar el recurso CheckoutSettings y los métodos asociados, asegúrate de hacer lo siguiente:

  • Debes tener la aprobación para participar en los anuncios de Shopping, las fichas gratuitas o ambos.
  • Tu país de venta debe ser Estados Unidos.

Métodos

Para crear, recuperar, actualizar y borrar la configuración de confirmación de la compra, puedes usar los siguientes métodos:

Crea la configuración de confirmación de la compra

Para crear un parámetro de configuración de confirmación de la compra, usa el método checkoutSettings.create. Incluye el uri_settings con checkout_uri_template o cart_uri_template y el eligible_destinations seleccionado en el cuerpo de la solicitud.

Esta es una solicitud de ejemplo:

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"
  ]
}

Reemplaza {ACCOUNT_ID} por el identificador único de tu cuenta de Merchant Center.

Esta es una respuesta de ejemplo de una llamada correcta:

{
  "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"
}

Cómo recuperar la configuración de confirmación de la compra

Para recuperar la configuración de confirmación de la compra, incluida la plantilla de URL, los destinos seleccionados, el estado de inscripción y el estado de revisión de la URL, usa el método checkoutSettings.get.

Esta es una solicitud de ejemplo:

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

Esta es una respuesta de ejemplo de una llamada correcta:

{
  "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"
}

Actualiza la configuración de confirmación de la compra

Para actualizar la configuración de confirmación de la compra, usa el método checkoutSettings.update. Incluye los campos que deseas cambiar en el cuerpo de la solicitud y especifícalos en el parámetro de consulta update_mask.

update_mask admite los siguientes campos:

  • eligible_destinations
  • uri_settings

A continuación, se muestra una solicitud de muestra que actualiza la URL y quita el destino de los anuncios:

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"
  ]
}

Esta es una respuesta de ejemplo de una llamada correcta:

{
  "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"
}

Borrar

Para borrar la configuración de confirmación de la compra, usa el método checkoutSettings.delete.

Esta acción quita la configuración a nivel de la cuenta, cancela tu inscripción en el programa de confirmación de la compra y evita que los vínculos de confirmación de la compra aparezcan en tus productos en las fichas gratuitas y los anuncios de Shopping.

Esta es una solicitud de ejemplo:

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

Una llamada correcta muestra un cuerpo de respuesta vacío.

Existen dos maneras de proporcionar URLs de confirmación de la compra para tus productos:

  • A nivel de la cuenta (sub-API o Merchant Center): Para definir una sola plantilla de URL, ya sea checkout_uri_template o cart_uri_template, puedes usar la sub-API o la configuración de Merchant Center. Esta plantilla se aplica a todos tus productos aptos. Te recomendamos que tengas una URL coherente en todos tus productos. Por ejemplo: yourstore.com/checkout?id={id}.

  • A nivel del producto (feed): Para proporcionar una URL de confirmación de la compra específica para productos individuales, usa el atributo checkout_link_template en tu feed de productos. Esto permite crear URLs personalizadas por producto o ofrecer la confirmación de la compra solo para un subconjunto de tu inventario.

  • Si configuras una plantilla de URL a nivel de la cuenta con esta sub-API, asegúrate de no enviar valores para el atributo checkout_link_template en tu feed para esos productos.

  • Si usas el atributo del feed checkout_link_template, asegúrate de no configurar una plantilla de URL a nivel de la cuenta con la configuración de la sub-API o de Merchant Center. Puedes seguir usando la sub-API para seleccionar eligible_destinations sin proporcionar uri_settings si administras las URLs solo a través del feed.

Plantilla de URL de confirmación de la compra

La plantilla de URL de confirmación de la compra te permite incluir en tus datos de productos una URL de confirmación de la compra, la cual ofrece a los compradores en línea la opción de ir directamente a tu página de confirmación de compras desde tus fichas. Debe contener el marcador de posición del parámetro {ID} y tener un dominio que coincida.

Cuando configures los vínculos de confirmación de la compra con la sub-API, usa el campo uri_settings. Este campo acepta una de las siguientes dos plantillas:

  • checkout_uri_template: Es una plantilla de URL que, cuando se completa el marcador de posición, dirige al usuario a tu página de confirmación de compra con el artículo específico listo para comprar.
  • cart_uri_template: Es una plantilla de URL que dirige al usuario a la página del carrito de compras con el artículo específico agregado al carrito.

Plantillas de ejemplo

  • Confirmación de la compra: https://www.your-store.com/checkout?item_id={id}
  • Carrito: https://shop.your-store.com/add_to_cart?product_sku={id}

Asegúrate de cumplir con los siguientes requisitos:

  • La plantilla de URL debe apuntar a una página válida de tu sitio que coincida con tu dominio registrado, funcione con el método HTTP GET y no requiera que el cliente acceda.
  • El dominio de la plantilla de confirmación de la compra proporcionada debe coincidir con el dominio del producto.

Más información