Migrer les paramètres de la page d'accueil

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

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

Principales différences

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 précises : l'API Merchant propose des méthodes spécifiques pour :
  • Récupérer les détails de la page d'accueil : accounts.homepage.getHomepage
  • Mettez à jour l'URI de la page d'accueil : accounts.homepage.updateHomepage
  • Revendiquer la page d'accueil : accounts.homepage.claim
  • Refuser la page d'accueil : accounts.homepage.unclaim L'API Content for Shopping utilise accounts.claimwebsite pour l'action de revendication, accounts.update pour définir l'URL (et la refuser en définissant une URL vide), et accounts.get/accountstatuses.get pour récupérer l'URL et l'état de la revendication, respectivement.
• 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, ce qui permet d'obtenir un retour 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.
• Exclusion explicite de responsabilité : dans Content API for Shopping, l'exclusion de responsabilité était généralement obtenue en remplaçant Account.website_url par une chaîne vide. L'API Merchant fournit une méthode homepage.unclaim dédiée.
• Remplacer une 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 vérifié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 (paramètre Account.website_url)	PATCH /accounts/v1/accounts/{account}/homepage
Revendiquer ou revalider la page d'accueil	POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (action effectuée le Account.website_url, définie à l'aide de accounts.update)	POST /accounts/v1/accounts/{account}/homepage:claim
Refuser la page d'accueil	accounts.update (en définissant 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 Merchant API.

Méthode Content API for Shopping	Méthode de l'API Merchant	Disponibilité et remarques
accounts.claimwebsite	accounts.homepage.claim	Lance ou revalide directement une revendication de site Web. Agit sur le uri précédemment défini à l'aide de homepage.update. Inclut un paramètre overwrite. Renvoie la ressource Homepage avec son état uri et claimed actuel.
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 la page d'accueil actuelle uri 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 la page d'accueil uri.
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 dissocier explicitement 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é, pour se rapprocher de 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 à accountId dans 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 (booléen dans le corps ContentAccountsClaimwebsiteRequest et AccountsCustomBatchRequestEntry)	ClaimHomepageRequest.overwrite (booléen dans le corps de la requête homepage.claim)	Facultatif. Si true tente de revendiquer le site Web, une revendication existante d'un autre compte peut être supprimée si la propriété peut être vérifiée par le compte demandeur.
Account.website_url (champ de la ressource Account, défini à l'aide de accounts.update, lu à l'aide de accounts.get)	Homepage.uri (champ de la ressource Homepage)	URI (URL) de la page d'accueil du magasin. Dans l'API Merchant, il s'agit d'un champ explicite de la ressource Homepage. Elle est définie à l'aide de accounts.homepage.updateHomepage et renvoyée par toutes les méthodes Homepage.
AccountStatus.website_claimed (champ de la ressource AccountStatus, lu à l'aide de accountstatuses.get)	Homepage.claimed (champ booléen output_only dans la ressource Homepage)	Indique si le uri a été revendiqué et validé. Cet état est directement disponible dans la ressource Homepage renvoyée par toutes les méthodes de l'API Merchant qui lui sont associées.
N/A	Paramètre de corps de requête UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage	Masque de champ facultatif pour homepage.update permettant de spécifier les champs (par exemple, uri) de la ressource Homepage sont en cours de mise à jour.