En este documento, se explica cómo migrar de Content API v2.1 a Merchant API.
Descripción general de los cambios de Content API v2.1 a Merchant API
Merchant API presenta mejoras significativas con respecto a la versión 2.1 de Content API, con el objetivo de mejorar la usabilidad, la coherencia y la flexibilidad para los desarrolladores y las empresas.
Estructura de recursos detallados
Los recursos de la API de Merchant representan conceptos individuales, como account
, businessDetails
, user
, homepage
y program
. Se organizan de manera jerárquica para reflejar sus relaciones. Por ejemplo, un account
es el recurso superior de un user
.
Servicios de cuenta unificados
Todos los servicios de la cuenta (por ejemplo, la agregación de cuentas para las MCA y sus
subcuentas, o entre cuentas y proveedores de servicios externos) se administran
mediante un recurso accountService
unificado. Los proveedores de servicios pueden administrar sus relaciones con el recurso accountRelationship
.
Estructura de URL simplificada
Las URLs ahora usan un solo ID de cuenta (por ejemplo, merchantapi.googleapis.com/accounts/v1beta/accounts/{accountId}
) en lugar de varios IDs. Las rutas de URL reflejan la estructura de recursos detallada.
Otras mejoras
- Administración mejorada de usuarios y programas: Los programas como los anuncios de Shopping y las fichas gratuitas se consolidan en un solo recurso
program
. El recursouser
incluye funciones de administración integrales con derechos de acceso detallados. - Información y identidad de la empresa estructurada: Existen recursos específicos para
businessInfo
ybusinessIdentity
. Incluyen compatibilidad con el cumplimiento de los requisitos con campos para datos específicos de la región. Por ejemplo, el número de registro comercial de Corea - Asignación optimizada de la página principal: Un recurso
homepage
dedicado administra la URL de la página principal de la tienda. Métodos comoclaim
yunclaim
controlan el reclamo de sitios web directamente a través de la API. - Cumplimiento de los lineamientos de la API de Google: El objetivo de la API de Merchant es alinearse con las propuestas de mejora de la API de Google.
Migración de la administración de la cuenta
Puedes usar el recurso accounts
para crear y administrar tu cuenta de comerciante. Para obtener más información, consulta la descripción general de la API de Merchant Accounts.
En esta página, se describe cómo puedes migrar la administración de cuentas de la API de Content a la API de Merchant.
Solicitudes
Usa el siguiente formato de URL de solicitud para la API de Merchant Accounts:
POST https://merchantapi.googleapis.com/accounts/v1beta/{accountId}/accounts
A continuación, se muestra una comparación de muestra de Content API for Shopping con la API de Merchant Accounts para solicitudes de creación y administración de cuentas:
Content API for Shopping | API de Merchant Accounts | |
---|---|---|
URL | https://shoppingcontent.googleapis.com/content/v2.1/ merchantId/accounts/ accountId/ |
https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId |
Identificadores | merchantId/accounts/ accountId |
accounts/ accountId |
Recursos
Los datos de la cuenta se pasan con el recurso Account
en Content API for Shopping. La API de Merchant Accounts proporciona varios recursos para pasar datos de las cuentas. Estos recursos incluyen Account
, User
, BusinessInfo
y BusinessIdentity
.
En la siguiente tabla, se muestra una comparación entre el recurso Account
de Content API for Shopping y el recurso Account
de la API de Merchant Accounts.
Content API for Shopping | API de Merchant Accounts |
---|---|
id |
name |
name |
accountName |
kind |
No disponible |
websiteUrl |
Campo uri en el recurso Homepage |
adultContent |
adultContent |
sellerId |
Campo accountIdAlias en el recurso AccountRelationship |
users |
En el recurso [User](/merchant/api/reference/rest/v1/accounts.v1beta.accounts.users) |
youtubeChannelLinks |
Aún no está disponible |
googleMyBusinessLink |
Aún no está disponible |
businessInformation |
En el recurso [businessInfo](/merchant/api/reference/rest/v1/BusinessInfo) |
businessIdentity |
En el recurso [businessIdentity](/merchant/api/reference/rest/v1/BusinessIdentity) |
automaticImprovements |
Aún no está disponible |
adsLinks |
Campo campaignsManagement en el recurso AccountService |
cssId |
Solo está disponible en la API de CSS. |
labelIds |
Solo está disponible en la API de CSS. |
accountManagement |
Campo accountManagement en el recurso AccountService |
automaticLabelIds |
Solo está disponible en la API de CSS. |
conversionSettings |
Aún no está disponible |
En la siguiente tabla, se proporciona una comparación entre el recurso AccountUser
en Content API for Shopping y el recurso User
en la API de Merchant Accounts.
Content API for Shopping | API de Merchant Accounts |
---|---|
emailAddress |
El correo electrónico es parte de name (accounts/{account}/users/{email} ). |
admin |
user#accessRights.ADMIN |
orderManager |
No disponible |
paymentsManager |
No disponible |
paymentsAnalyst |
No disponible |
reportingManager |
user#accessRights.PERFORMANCE_REPORTING |
En la siguiente tabla, se proporciona una comparación entre el recurso AccountBusinessInformation
en Content API for Shopping y su recurso equivalente businessInfo
en la API de Merchant Accounts.
Content API for Shopping | API de Merchant Accounts |
---|---|
businessInformation |
businessInfo |
phoneNumber |
phone |
phoneVerificationStatus |
phoneVerificationState |
customerService |
customerService |
koreanBusinessRegistrationNumber |
koreanBusinessRegistrationNumber |
En la siguiente tabla, se proporciona una comparación entre el recurso AccountBusinessIdentity
en Content API for Shopping y el recurso businessIdentity
en la API de Merchant Accounts.
Content API for Shopping | API de Merchant Accounts |
---|---|
blackOwned |
blackOwned |
womenOwned |
womenOwned |
veteranOwned |
veteranOwned |
latinoOwned |
latinoOwned |
smallBusiness |
smallBusiness |
includeForPromotions |
promotionsConsent |
- true significa PROMOTION_CONSENT_GIVEN |
|
- false significa PROMOTION_CONSENT_DENIED |
El recurso AccountIdentityType
en la API de Content se representa con el tipo IdentityAttribute
y su campo identityDeclaration
en MerchantAPI.
Content API for Shopping | API de Merchant Accounts |
---|---|
self_identified |
identityDeclaration |
- true significa SELF_IDENTIFIES_AS |
|
- false significa DOES_NOT_SELF_IDENTIFY_AS |
Métodos
Se introdujeron los siguientes métodos en la API de Merchant Accounts:
Content API for Shopping | API de Merchant Accounts |
---|---|
accounts.authinfo |
GET https://merchantapi.googleapis.com/accounts/v1beta/accounts sin filtro |
accounts.claimwebsite |
POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId/homepage:claim |
Para obtener más información, consulta Método: accounts.v1beta.accounts.homepage.claim. | |
accounts.custombatch |
No disponible. El lote personalizado no es compatible con la API de Merchant. |
accounts.delete |
DELETE https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId |
accounts.get |
GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId` |
accounts.insert |
POST https://merchantapi.googleapis.com/accounts/v1beta/accounts:createAndConfigure |
Para obtener más información, consulta Cómo crear y configurar una cuenta de comerciante. | |
accounts.link |
recurso AccountService |
accounts.list |
GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId:listSubaccounts |
accounts.listlinks |
GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId/services |
accounts.update |
Se asigna a una solicitud de actualización del recurso en la que se define el campo o el conjunto de campos obligatorios. |