Gérer les paramètres de paiement

La fonctionnalité de paiement accélère les achats pour les clients prêts à acheter en leur permettant d'accéder directement à la page de paiement ou au panier de votre site Web depuis les fiches produit Google. Cela peut améliorer les taux de conversion et fluidifier l'expérience d'achat.

Avec l'API Merchant, vous pouvez gérer les paramètres de cette fonctionnalité à l'aide de la ressource CheckoutSettings.

Ce guide explique comment utiliser l'API Merchant pour créer et gérer votre inscription à la fonctionnalité de paiement par programmation.

Pour en savoir plus, consultez Ajouter un lien vers la page de paiement pour vos produits.

Prérequis

Pour utiliser la ressource CheckoutSettings et les méthodes associées, assurez-vous de procéder comme suit :

  • Vous devez être approuvé pour les annonces Shopping, les fiches gratuites ou les deux, et y participer.
  • Votre pays de vente doit être les États-Unis.

Méthodes

Pour créer, récupérer, mettre à jour et supprimer des paramètres de paiement, vous pouvez utiliser les méthodes suivantes :

Créer des paramètres de paiement

Pour créer un paramètre de paiement, utilisez la méthode checkoutSettings.create. Incluez le uri_settings avec checkout_uri_template ou cart_uri_template, ainsi que le eligible_destinations sélectionné dans le corps de la requête.

Voici un exemple de requête :

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

Remplacez {ACCOUNT_ID} par l'identifiant unique de votre compte Merchant Center.

Voici un exemple de réponse à un appel réussi :

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

Récupérer les paramètres de paiement

Pour récupérer vos paramètres de règlement, y compris le modèle d'URL, les destinations sélectionnées, l'état de l'inscription et l'état de l'examen de l'URL, utilisez la méthode checkoutSettings.get.

Voici un exemple de requête :

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

Voici un exemple de réponse à un appel réussi :

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

Modifier les paramètres de paiement

Pour mettre à jour vos paramètres de paiement, utilisez la méthode checkoutSettings.update. Incluez les champs que vous souhaitez modifier dans le corps de la requête et spécifiez-les dans le paramètre de requête update_mask.

update_mask accepte les champs suivants :

  • eligible_destinations
  • uri_settings

Voici un exemple de requête permettant de mettre à jour l'URL et de supprimer la destination des annonces :

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

Voici un exemple de réponse à un appel réussi :

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

Supprimer

Pour supprimer les paramètres de paiement, utilisez la méthode checkoutSettings.delete.

Cette action supprime votre configuration au niveau du compte, vous désinscrit du programme de paiement et empêche les liens de paiement d'apparaître sur vos produits dans les fiches gratuites et les annonces Shopping.

Voici un exemple de requête :

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

Les appels réussis renvoient un corps de réponse vide.

Vous pouvez fournir les URL de paiement de vos produits de deux manières :

  • Au niveau du compte (sous-API ou Merchant Center) : pour définir un seul modèle d'URL, checkout_uri_template ou cart_uri_template, vous pouvez utiliser la sous-API ou les paramètres Merchant Center. Ce modèle s'applique à tous vos produits éligibles. Nous vous recommandons d'utiliser une URL cohérente pour tous vos produits. Exemple : yourstore.com/checkout?id={id}.

  • Au niveau du produit (flux) : pour fournir une URL de règlement spécifique à des produits individuels, utilisez l'attribut checkout_link_template dans votre flux de produits. Vous pouvez ainsi personnaliser les URL par produit ou n'offrir le paiement qu'à un sous-ensemble de votre inventaire.

  • Si vous définissez un modèle d'URL au niveau du compte à l'aide de cette sous-API, veillez à ne pas envoyer de valeurs pour l'attribut checkout_link_template dans votre flux pour ces produits.

  • Si vous utilisez l'attribut de flux checkout_link_template, assurez-vous de ne pas définir de modèle d'URL au niveau du compte à l'aide des paramètres de la sous-API ou de Merchant Center. Vous pouvez toujours utiliser la sous-API pour sélectionner eligible_destinations sans fournir uri_settings si vous gérez les URL uniquement via le flux.

Modèle d'URL de paiement

Le modèle d'URL de paiement vous permet d'ajouter une URL de paiement dans vos données produit pour que les acheteurs en ligne puissent accéder directement à votre page de paiement depuis vos fiches. Il doit contenir l'espace réservé du paramètre {ID} et disposer d'un domaine correspondant.

Lorsque vous configurez des liens de paiement à l'aide de la sous-API, utilisez le champ uri_settings. Ce champ accepte l'un des deux modèles suivants :

  • checkout_uri_template : modèle d'URL qui, lorsque l'espace réservé est renseigné, redirige l'utilisateur vers votre page de paiement avec l'article spécifique prêt à être acheté.
  • cart_uri_template : modèle d'URL qui redirige l'utilisateur vers la page de votre panier avec l'article spécifique ajouté au panier.

Exemples de modèles

  • Règlement : https://www.your-store.com/checkout?item_id={id}
  • Panier : https://shop.your-store.com/add_to_cart?product_sku={id}

Assurez-vous de remplir les conditions suivantes :

  • Votre modèle d'URL doit pointer vers une page valide de votre site qui correspond à votre domaine enregistré, fonctionne à l'aide de la méthode HTTP GET et ne nécessite pas que le client se connecte.
  • Le domaine du modèle de paiement fourni doit correspondre au domaine du produit.

En savoir plus