Migrer la gestion de compte à partir de Content API for Shopping

Ce document explique comment passer de la version 2.1 de Content API à l'API Merchant.

Présentation des modifications apportées de la version 2.1 de Content API à Merchant API

Merchant API apporte des améliorations importantes par rapport à la version 2.1 de Content API. Elle vise à améliorer la facilité d'utilisation, la cohérence et la flexibilité pour les développeurs et les entreprises.

Structure des ressources précise

Les ressources de l'API Merchant représentent des concepts uniques, tels que account, businessDetails, user, homepage et program. Ils sont organisés de manière hiérarchique pour refléter leurs relations. Par exemple, un account est la ressource parente d'un user.

Services de compte unifiés

Tous les services de compte (par exemple, l'agrégation de comptes pour les MC et leurs sous-comptes, ou entre les fournisseurs de services tiers et les comptes) sont gérés via une ressource accountService unifiée. Les fournisseurs de services peuvent gérer leurs relations à l'aide de la ressource accountRelationship.

Structure d'URL simplifiée

Les URL utilisent désormais un seul ID de compte (par exemple, merchantapi.googleapis.com/accounts/v1beta/accounts/{accountId}) au lieu de plusieurs. Les chemins d'URL reflètent la structure détaillée des ressources.

Autres améliorations

  • Gestion améliorée des programmes et des utilisateurs: les programmes tels que les annonces Shopping et les fiches gratuites sont regroupés dans une seule ressource program. La ressource user inclut des fonctionnalités de gestion complètes avec des droits d'accès précis.
  • Informations structurées sur l'établissement et identité de l'établissement: des ressources dédiées sont disponibles pour businessInfo et businessIdentity. Ils incluent la conformité avec des champs pour les données spécifiques à une région. (par exemple, le numéro d'immatriculation d'entreprise coréen)
  • Récupération simplifiée de la page d'accueil: une ressource homepage dédiée gère l'URL de la page d'accueil de la plate-forme. Des méthodes telles que claim et unclaim gèrent la revendication de sites Web directement via l'API.
  • Respect des consignes Google concernant les API: l'API Merchant vise à s'aligner sur les propositions d'amélioration des API de Google.

Migration de la gestion des comptes

Vous pouvez utiliser la ressource accounts pour créer et gérer votre compte marchand. Pour en savoir plus, consultez la section Présentation de l'API Merchant Accounts.

Cette page explique comment migrer la gestion de compte de Content API vers Merchant API.

Demandes

Utilisez le format d'URL de requête suivant pour l'API Merchant Accounts:

https://merchantapi.googleapis.com/accounts/v1beta/{accountId}/accounts

Voici un exemple de comparaison entre Content API for Shopping et l'API Merchant Accounts pour les requêtes de création et de gestion de comptes:

  Content API for Shopping API Merchant Accounts
URL https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/accounts/{accountId}/ https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*}
Identifiants merchantId,accountId ``nom

Ressources

Les données du compte sont transmises à l'aide de la ressource Account dans Content API for Shopping. L'API Merchant Accounts fournit plusieurs ressources pour transmettre les données des comptes. Ces ressources incluent les ressources Account, User, BusinessInfo et BusinessIdentity.

Le tableau suivant compare la ressource Account dans Content API for Shopping et la ressource Account dans l'API Merchant Accounts.

Content API for Shopping API Merchant Accounts
id name
name accountName
kind Non disponible
websiteUrl Champ uri dans la ressource Homepage
adultContent adultContent
sellerId Champ accountIdAlias dans la ressource AccountRelationship
users Dans la ressource User
youtubeChannelLinks Pas encore disponible
googleMyBusinessLink Pas encore disponible
businessInformation Dans la ressource businessInfo
businessIdentity Dans la ressource businessIdentity
automaticImprovements Pas encore disponible
adsLinks Champ campaignsManagement dans la ressource AccountService
cssId Disponible uniquement dans l'API CSS
labelIds Disponible uniquement dans l'API CSS
accountManagement Champ accountManagement dans la ressource AccountService
automaticLabelIds Disponible uniquement dans l'API CSS
conversionSettings Pas encore disponible

Le tableau suivant compare la ressource AccountUser dans Content API for Shopping et la ressource User dans l'API Merchant Accounts.

Content API for Shopping API Merchant Accounts
emailAddress L'adresse e-mail fait partie de name (accounts/{account}/users/{email}).
admin user#accessRights.ADMIN
orderManager Non disponible
paymentsManager Non disponible
paymentsAnalyst Non disponible
reportingManager user#accessRights.PERFORMANCE_REPORTING

Le tableau suivant compare la ressource AccountBusinessInformation dans Content API for Shopping et sa ressource équivalente businessInfo dans l'API Merchant Accounts.

Content API for Shopping API Merchant Accounts
address address
phoneNumber phone
phoneVerificationStatus phoneVerificationState
customerService customerService
koreanBusinessRegistrationNumber koreanBusinessRegistrationNumber

Le tableau suivant compare la ressource AccountBusinessIdentity dans Content API for Shopping et la ressource businessIdentity dans l'API Merchant Accounts.

Content API for Shopping API Merchant Accounts
blackOwned blackOwned
womenOwned womenOwned
veteranOwned veteranOwned
latinoOwned latinoOwned
smallBusiness smallBusiness
includeForPromotions promotionsConsent
- true signifie PROMOTION_CONSENT_GIVEN
- false signifie PROMOTION_CONSENT_DENIED

La ressource AccountIdentityType de Content API est représentée par le type IdentityAttribute et son champ identityDeclaration dans MerchantAPI.

Content API for Shopping API Merchant Accounts
self_identified identityDeclaration
- true signifie SELF_IDENTIFIES_AS
- false signifie DOES_NOT_SELF_IDENTIFY_AS

Méthodes

Les méthodes suivantes ont été introduites dans l'API Merchant Accounts:

Content API for Shopping API Merchant Accounts
accounts.authinfo GET https://merchantapi.googleapis.com/accounts/v1beta/accounts sans filtre
accounts.claimwebsite POST https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}/homepage:claim Pour en savoir plus, consultez la méthode: accounts.v1beta.accounts.homepage.claim.
accounts.custombatch Non disponible. Les lots personnalisés ne sont pas acceptés dans l'API Merchant.
accounts.delete DELETE https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*}
accounts.get GET https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*}`
accounts.insert POST https://merchantapi.googleapis.com/accounts/v1beta/accounts:createAndConfigure Pour en savoir plus, consultez Créer et configurer un compte marchand.
accounts.link Ressource AccountService
accounts.list GET https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}:listSubaccounts
accounts.listlinks GET https://merchantapi.googleapis.com/accounts/v1beta/{parent=accounts/*}/services
accounts.requestphoneverification Non compatible.
accounts.update Correspond à une requête de mise à jour de la ressource où le champ ou l'ensemble de champs obligatoires sont définis.
accounts.updatelabels Disponible uniquement dans l'API CSS
accounts.verifyphonenumber Non compatible.