La función de confirmación de compra acelera el proceso de compra 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 conversiones y facilitar 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 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, y participar en ellos.
- Tu país de venta debe ser Estados Unidos.
Métodos
Para crear, recuperar, actualizar y borrar la configuración de confirmación de compra, puedes usar los siguientes métodos:
Crea la configuración de confirmación de compra
Para crear un parámetro de configuración de confirmación de la compra, usa el método checkoutSettings.create.
Incluye uri_settings con checkout_uri_template o
cart_uri_template y el eligible_destinations seleccionado en el cuerpo de la
solicitud.
A continuación, se muestra 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.
A continuación, se muestra 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"
}
Recupera 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.
A continuación, se muestra una solicitud de ejemplo:
GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings
A continuación, se muestra 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 compra
Para actualizar la configuración de confirmación de compra, usa el método checkoutSettings.update. Incluye los campos que deseas cambiar en el cuerpo de la solicitud y especifica
esos campos en el parámetro de consulta update_mask.
update_mask admite los siguientes campos:
eligible_destinationsuri_settings
A continuación, se muestra una solicitud de ejemplo para actualizar la URL y quitar el destino del anuncio:
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"
]
}
A continuación, se muestra 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, te da de baja del programa de confirmación de compra y evita que aparezcan vínculos de confirmación de compra en tus productos en las fichas gratuitas y los anuncios de Shopping.
A continuación, se muestra una solicitud de ejemplo:
DELETE https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings
Una llamada correcta devuelve un cuerpo de respuesta vacío.
Vínculos de confirmación de compra a nivel de la cuenta frente a los vínculos a nivel del producto
Existen dos maneras de proporcionar las URLs de confirmación de compra de tus productos:
A nivel de la cuenta (API secundaria o Merchant Center): Para definir una sola plantilla de URL, ya sea
checkout_uri_templateocart_uri_template, puedes usar la API secundaria o la configuración de Merchant Center. Esta plantilla se aplica a todos tus productos aptos. Te recomendamos que uses 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_templateen tu feed de productos. Esto permite personalizar las URLs por producto o que ofrezcas la confirmación de la compra solo para un subconjunto de tu inventario.Si estableces una plantilla de URL a nivel de la cuenta con esta sub-API, asegúrate de no enviar valores para el atributo
checkout_link_templateen tu feed para esos productos.Si usas el atributo del feed
checkout_link_template, asegúrate de no establecer una plantilla de URL a nivel de la cuenta con la sub-API o la configuración de Merchant Center. Aún puedes usar la API secundaria para seleccionar eleligible_destinationssin proporcionaruri_settingssi administras URLs solo a través del feed.
Plantilla de URL de confirmación de compra
La plantilla de URL de confirmación de compra te permite incluir una URL de confirmación de compra en tus datos de productos, la cual ofrece a los compradores en línea la opción de ir directamente a tu página de confirmación de compra desde tus fichas. Debe contener el marcador de posición del parámetro {ID} y tener un dominio coincidente.
Cuando configures los vínculos de confirmación de compra con la sub-API, usa el campo uri_settings.
Este campo acepta una de las dos plantillas siguientes:
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 de tu carrito de compras con el artículo específico agregado al carrito.
Plantillas de ejemplo
- Confirmación de 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 dirigir a una página válida de tu sitio que coincida con tu
dominio registrado, funcione con el método
HTTP GETy 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.