Compatibilité avec Content API for Shopping

Vous pouvez utiliser ce guide pour intégrer l'API Merchant à votre implémentation existante de Content API for Shopping.

Commencer

Pour en savoir plus sur l'API Merchant Center et ses sous-API, consultez Conception de l'API Merchant Center.

Pour commencer à utiliser l'API Merchant Center, modifiez les URL de vos requêtes au format suivant:

https://merchantapi.googleapis.com/{sub-API}/{version}/{resource name}/{service}:{method}

Pour en savoir plus, consultez le guide de démarrage rapide et la documentation de référence sur l'API Merchant.

Compatibilité avec gRPC

L'API Merchant est compatible avec gRPC et REST. Vous pouvez utiliser simultanément gRPC pour l'API Merchant et REST pour Content API for Shopping.

Les bibliothèques clientes de l'API Merchant nécessitent gRPC.

Pour en savoir plus, consultez la page Utiliser gRPC.

Compatibilité

Ce guide décrit les modifications générales qui s'appliquent à l'ensemble de l'API pour les marchands. Consultez les guides suivants pour découvrir les modifications apportées à des fonctionnalités spécifiques:

Merchant API est conçue pour fonctionner avec les fonctionnalités existantes de la version 2.1 de Content API for Shopping.

Par exemple, vous pouvez utiliser l'API Merchant Inventories avec vos inventaires Content API for Shopping version 2.1 et votre implémentation products. Vous pouvez utiliser Content API for Shopping pour importer un nouveau produit en magasin (que vous vendez dans un magasin), puis utiliser la ressource LocalInventory de l'API Merchant Inventories pour gérer les informations en magasin pour ce produit.

Requêtes par lot

L'API Merchant Center n'est pas compatible avec la méthode customBatch présentée dans Content API for Shopping. Consultez plutôt la section Envoyer des requêtes par lot. Si vous utilisez customBatch et que vous avez besoin de cette fonctionnalité pour l'API Merchant Center, veuillez nous expliquer pourquoi dans vos commentaires.

Identifiants

Pour nous aligner sur les principes d'amélioration des API de Google, nous avons apporté des modifications aux identifiants des ressources de l'API Merchant Center.

remplace "Id"

Toutes les ressources de l'API Merchant utilisent le champ name comme identifiant unique.

Voici un exemple d'utilisation du champ name dans vos appels:

POST https://merchantapi.googleapis.com/inventories/v1beta/{parent}/regionalInventories:insert

Ce nouveau champ name est renvoyé en tant qu'identifiant de ressource pour tous les appels de lecture et d'écriture dans l'API Merchant.

La valeur renvoyée dans les champs name utilise le nouveau format d'ID.

Par exemple, implémentez une méthode getName() pour récupérer l'name à partir d'une ressource, puis stockez la sortie en tant que variable au lieu de créer vous-même l'name à partir du marchand et des ID de ressource.

Nouveau format d'ID

Dans l'API Merchant Center, les ID de ressource utilisent le format suivant : channel~language~feedLabel~offerId

Les ressources Content API ont utilisé : au lieu de ~ entre chaque valeur de l'ID : channel:language:feedLabel:offerId

Tous les appels d'API Merchant Center renvoient le nouveau format, avec ~ entre les valeurs de l'ID. Nous vous recommandons de stocker le nouveau format de la réponse et de l'utiliser dans vos futurs appels.

champs parents pour les ressources enfants

Dans l'API Merchant Center, toutes les ressources enfants comportent le champ parent. Vous pouvez utiliser le champ parent pour spécifier le name de la ressource dans laquelle insérer l'enfant, au lieu de transmettre l'intégralité de la ressource parente. Vous pouvez également utiliser le champ parent avec les méthodes list pour répertorier les ressources enfants de ce parent.

Par exemple, pour répertorier les inventaires en magasin d'un produit donné, spécifiez la name du produit dans le champ parent de la méthode list. Dans ce cas, la valeur product donnée est l'parent des ressources LocalInventory renvoyées.

Types

Voici quelques types courants partagés entre les sous-API de l'API Merchant Center.

Prix

Voici les modifications apportées à Price dans le package Merchant Common:

Content API API Merchant Center
Champ du montant value:string amountMicros:int64
Champ de devise currency:string currencyCode:string

Le montant de Price est désormais enregistré en micros, où 1 million de micro-unités équivaut à l'unité standard de votre devise.

Dans Content API for Shopping, Price était un nombre décimal sous forme de chaîne.

Le nom du champ du montant est passé de value à amountMicros

Le nom du champ de devise est passé de currency à currencyCode. Le format reste ISO 4217.