Migra la configuración de la página principal

La API de Merchant presenta un recurso Homepage dedicado. Este recurso proporciona métodos nuevos para administrar el reclamo de tu página principal y ofrece capacidades más allá de la Content API for Shopping clásica.

El acceso a las funciones de tu tienda en línea es un proceso de dos pasos: primero, se verifica la propiedad y, luego, se reclama el sitio para tu cuenta. Para completar el paso final, usa el accounts.homepage.claim.

Diferencias clave

La API de Merchant realiza varios cambios relacionados con la página principal en comparación con Content API for Shopping:

  • Recurso dedicado: La API de Merchant proporciona un recurso Homepage distinto (accounts.homepage) para todas las operaciones relacionadas con la página principal. (En Content API for Shopping, usabas accounts.claimwebsite para realizar la acción de reclamo, la URL de la página principal (website_url) formaba parte del recurso Account y el estado del reclamo (website_claimed) formaba parte del recurso AccountStatus).
  • Métodos granulares: La API de Merchant ofrece métodos específicos para lo siguiente:
    • Recuperar los detalles de la página principal: accounts.homepage.getHomepage
    • Actualizar el URI de la página principal: accounts.homepage.updateHomepage
    • Reclamar la página principal: accounts.homepage.claim
    • Anular el reclamo de la página principal: accounts.homepage.unclaim Content API for Shopping usaba accounts.claimwebsite para la acción de reclamo, accounts.update para establecer la URL (y, de hecho, anular el reclamo estableciendo una URL vacía) y accounts.get/accountstatuses.get para recuperar la URL y el estado del reclamo, respectivamente.
  • Información centralizada: El recurso Homepage de la API de Merchant contiene directamente el uri (URL de la página principal) y el estado claimed. Todos los métodos que operan en el recurso Homepage muestran este recurso, lo que proporciona comentarios inmediatos sobre el estado actual. En Content API for Shopping, accounts.claimwebsite no mostraba el estado actualizado; se necesitaban llamadas independientes.
  • Anulación de reclamo explícita: En Content API for Shopping, la anulación del reclamo se lograba por lo general, actualizando Account.website_url a una cadena vacía. La API de Merchant proporciona un método dedicado homepage.unclaim.
  • Reemplazo del reclamo: Ambas APIs admiten un parámetro overwrite durante el proceso de reclamo para hacerse cargo de un reclamo de otra cuenta si se puede verificar la propiedad.

Solicitudes

La API de Merchant usa extremos RESTful distintos para administrar diferentes aspectos de la página principal.

Descripción de la solicitud Content API for Shopping API de Merchant
Obtén los detalles de la página principal accounts.get (para leer Account.website_url), accountstatuses.get (para leer AccountStatus.website_claimed) GET /accounts/v1/accounts/{account}/homepage
Actualiza el URI de la página principal accounts.update (establece Account.website_url) PATCH /accounts/v1/accounts/{account}/homepage
Reclama o vuelve a verificar la página principal POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (actuó en Account.website_url establecido con accounts.update) POST /accounts/v1/accounts/{account}/homepage:claim
Anula el reclamo de la página principal accounts.update (establece Account.website_url en una cadena vacía) POST /accounts/v1/accounts/{account}/homepage:unclaim

Identificadores

La identificación de recursos se optimizó en la API de Merchant.

Descripción del identificador Content API for Shopping API de Merchant
Identificador de cuenta para el acceso a recursos merchantId (cuenta avanzada) y accountId (subcuenta) en la ruta de acceso account (parte del campo name, como accounts/{account_id}/homepage)
Identificador de recursos de la página principal No aplicable (implícito para el recurso Account) name: accounts/{account_id}/homepage (identifica el subrecurso Homepage)

Métodos

El método accounts.claimwebsite de Content API for Shopping, que se enfocaba en la acción de reclamo, ahora forma parte de un conjunto más amplio de funcionalidades dentro del recurso Homepage de la API de Merchant.

Método de Content API for Shopping Método de la API de Merchant Disponibilidad y notas
accounts.claimwebsite accounts.homepage.claim Inicia o vuelve a verificar directamente un reclamo de sitio web. Actúa en el uri establecido anteriormente con homepage.update. Incluye un parámetro overwrite. Muestra el recurso Homepage con su estado uri y claimed actuales.
accounts.get (para leer Account.website_url), accountstatuses.get (para leer AccountStatus.website_claimed) accounts.homepage.getHomepage Nuevo método dedicado para recuperar el uri actual de la página principal y su estado claimed en una sola llamada.
accounts.update (para establecer Account.website_url) accounts.homepage.updateHomepage Nuevo método dedicado para establecer o cambiar el uri de la página principal.
accounts.update (establece Account.website_url en una cadena vacía como solución alternativa para anular el reclamo) accounts.homepage.unclaim Nuevo método dedicado para anular explícitamente el reclamo de una página principal.

Cambios detallados en los campos

La forma en que se estructura y se accede a la información de la página principal cambió significativamente y se dirige hacia el recurso Homepage explícito en la API de Merchant.

Content API for Shopping API de Merchant Descripción
merchantId (parámetro de ruta para accounts.claimwebsite) name (parámetro de ruta para los métodos Homepage, formato: accounts/{account}/homepage) La parte account de la cadena name en la API de Merchant corresponde al accountId de Content API for Shopping.
accountId (parámetro de ruta para accounts.claimwebsite) name (parámetro de ruta para los métodos Homepage, formato: accounts/{account}/homepage) El identificador de la cuenta específica cuya página principal se administra.
overwrite (booleano en el cuerpo de ContentAccountsClaimwebsiteRequest y AccountsCustomBatchRequestEntry) ClaimHomepageRequest.overwrite (booleano en el cuerpo de la solicitud homepage.claim) Es opcional. Si es true, intenta reclamar el sitio web y, potencialmente, quita un reclamo existente de otra cuenta si la cuenta solicitante puede verificar la propiedad.
Account.website_url (campo en el recurso Account, establecido con accounts.update, leído con accounts.get) Homepage.uri (campo en el recurso Homepage) El URI (URL) de la página principal de la tienda. En la API de Merchant, este es un campo explícito dentro del recurso Homepage. Se establece con accounts.homepage.updateHomepage y se muestra en todos los métodos Homepage.
AccountStatus.website_claimed (campo en el recurso AccountStatus, leído con accountstatuses.get) Homepage.claimed (campo booleano output_only en el recurso Homepage) Indica si se reclamó y verificó el uri. Este estado está disponible directamente en el recurso Homepage que muestran todos sus métodos asociados de la API de Merchant.
N/A UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage parámetro del cuerpo de la solicitud) Una máscara de campo opcional para homepage.update que especifica qué campos (p.ej., uri) del recurso Homepage se están actualizando.
Anterior
Migrate user and access management
Siguiente
Migrate region management