Migrer les paramètres de la page d'accueil

L'API Merchant introduit une ressource dédiée Homepage. Cette ressource fournit de nouvelles méthodes pour gérer votre revendication de page d'accueil, offrant des fonctionnalités allant au-delà de Content API for Shopping classique.

L'accès aux fonctionnalités de votre boutique en ligne se fait en deux étapes : d'abord, vous devez valider la propriété, puis revendiquer le site pour votre compte. Pour effectuer la dernière étape, utilisez accounts.homepage.claim.

Différences majeures

L'API Merchant apporte plusieurs modifications liées à la page d'accueil par rapport à Content API for Shopping :

  • Ressource dédiée : l'API Merchant fournit une ressource Homepage distincte (accounts.homepage) pour toutes les opérations liées à la page d'accueil. (Dans Content API for Shopping, vous utilisiez accounts.claimwebsite pour effectuer l'action de revendication, l'URL de la page d'accueil (website_url) faisait partie de la ressource Account, et l'état de la revendication (website_claimed) faisait partie de la ressource AccountStatus.)
  • Méthodes granulaires : l'API Merchant propose des méthodes spécifiques pour :
    • Récupérer les détails de la page d'accueil : accounts.homepage.getHomepage
    • Mettre à jour l'URI de la page d'accueil : accounts.homepage.updateHomepage
    • Revendiquer la page d'accueil : accounts.homepage.claim
    • Annuler la revendication de la page d'accueil : accounts.homepage.unclaim Content API for Shopping utilisait accounts.claimwebsite pour l'action de revendication, accounts.update pour définir l'URL (et annuler la revendication en définissant une URL vide), et accounts.get/accountstatuses.get pour récupérer respectivement l'URL et l' état de la revendication.
  • Informations centralisées : la ressource Homepage de l'API Merchant contient directement l'uri (URL de la page d'accueil) et l'état claimed. Toutes les méthodes fonctionnant sur la ressource Homepage renvoient cette ressource, fournissant un feedback immédiat sur l'état actuel. Dans Content API for Shopping, accounts.claimwebsite ne renvoyait pas l'état mis à jour. Des appels distincts étaient nécessaires.
  • Annulation explicite de la revendication : dans Content API for Shopping, l'annulation de la revendication était généralement obtenue en définissant Account.website_url sur une chaîne vide. L'API Merchant fournit une méthode dédiée homepage.unclaim.
  • Écrasement de la revendication : les deux API acceptent un paramètre overwrite lors du processus de revendication pour reprendre une revendication d'un autre compte si la propriété peut être validée.

Requêtes

L'API Merchant utilise des points de terminaison RESTful distincts pour gérer différents aspects de la page d'accueil.

Description de la requête Content API for Shopping API Merchant
Obtenir les détails de la page d'accueil accounts.get (pour lire Account.website_url), accountstatuses.get (pour lire AccountStatus.website_claimed) GET /accounts/v1/accounts/{account}/homepage
Mettre à jour l'URI de la page d'accueil accounts.update (définition de Account.website_url) PATCH /accounts/v1/accounts/{account}/homepage
Revendiquer ou valider à nouveau la page d'accueil POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (agissant sur Account.website_url défini à l'aide de accounts.update) POST /accounts/v1/accounts/{account}/homepage:claim
Annuler la revendication de la page d'accueil accounts.update (définition de Account.website_url sur une chaîne vide) POST /accounts/v1/accounts/{account}/homepage:unclaim

Identifiants

L'identification des ressources a été simplifiée dans l'API Merchant.

Description de l'identifiant Content API for Shopping API Merchant
Identifiant de compte pour l'accès aux ressources merchantId (compte avancé) et accountId (sous-compte) dans le chemin d'accès account (partie du champ name, par exemple, accounts/{account_id}/homepage)
Identifiant de ressource de la page d'accueil Non applicable (implicite à la ressource Account) name : accounts/{account_id}/homepage (identifie la sous-ressource Homepage)

Méthodes

La méthode accounts.claimwebsite de Content API for Shopping, qui était axée sur l'action de revendication, fait désormais partie d'un ensemble plus large de fonctionnalités au sein de la ressource Homepage de l'API Merchant.

Méthode Content API for Shopping Méthode API Merchant Disponibilité et remarques
accounts.claimwebsite accounts.homepage.claim Lance ou valide à nouveau directement une revendication de site Web. Agit sur l'uri précédemment défini à l'aide de homepage.update. Inclut un paramètre overwrite. Renvoie la ressource Homepage avec son uri actuel et son état claimed.
accounts.get (pour lire Account.website_url), accountstatuses.get (pour lire AccountStatus.website_claimed) accounts.homepage.getHomepage Nouvelle méthode dédiée pour récupérer l'uri actuel de la page d'accueil et son état claimed en un seul appel.
accounts.update (pour définir Account.website_url) accounts.homepage.updateHomepage Nouvelle méthode dédiée pour définir ou modifier l'uri de la page d'accueil.
accounts.update (définition de Account.website_url sur une chaîne vide comme solution de contournement pour annuler la revendication) accounts.homepage.unclaim Nouvelle méthode dédiée pour annuler explicitement la revendication d'une page d'accueil.

Modifications détaillées des champs

La façon dont les informations de la page d'accueil sont structurées et accessibles a considérablement changé, passant à la ressource Homepage explicite dans l'API Merchant.

Content API for Shopping API Merchant Description
merchantId (paramètre de chemin d'accès pour accounts.claimwebsite) name (paramètre de chemin d'accès pour les méthodes Homepage, format : accounts/{account}/homepage) La partie account de la chaîne name dans l'API Merchant correspond au accountId de Content API for Shopping.
accountId (paramètre de chemin d'accès pour accounts.claimwebsite) name (paramètre de chemin d'accès pour les méthodes Homepage, format : accounts/{account}/homepage) Identifiant du compte spécifique dont la page d'accueil est gérée.
overwrite (valeur booléenne dans le corps de ContentAccountsClaimwebsiteRequest et AccountsCustomBatchRequestEntry) ClaimHomepageRequest.overwrite (valeur booléenne dans le corps de la requête homepage.claim) Facultatif. Si la valeur est true, tente de revendiquer le site Web, en supprimant potentiellement une revendication existante d'un autre compte si la propriété peut être validée par le compte demandeur.
Account.website_url (champ dans la ressource Account, défini à l'aide de accounts.update, lu à l'aide de accounts.get) Homepage.uri (champ dans la ressource Homepage) URI (URL) de la page d'accueil de la boutique. Dans l'API Merchant, il s'agit d'un champ explicite dans la ressource Homepage. Il est défini à l'aide de accounts.homepage.updateHomepage et renvoyé par toutes les méthodes Homepage.
AccountStatus.website_claimed (champ dans la ressource AccountStatus, lu à l'aide de accountstatuses.get) Homepage.claimed (champ booléen output_only dans la ressource Homepage) Indique si l'uri est revendiqué et validé. Cet état est directement disponible dans la ressource Homepage renvoyée par toutes les méthodes d'API Merchant associées.
N/A UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage paramètre du corps de la requête) Masque de champ facultatif pour homepage.update afin de spécifier les champs (par exemple, uri) de la ressource Homepage qui sont mis à jour.
Précédent
Migrate user and access management
Suivant
Migrate region management