La API de Merchant Center introduce un recurso Homepage
dedicado. Este recurso proporciona métodos nuevos para administrar el reclamo de la página principal y ofrece capacidades más allá de la clásica Content API for Shopping.
El acceso a las funciones de tu tienda en línea es un proceso de dos pasos: primero, debes verificar la propiedad y, luego, reclamar el sitio para tu cuenta. Para completar el paso final, usa 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, usabasaccounts.claimwebsite
para realizar la acción de reclamo, la URL de la página principal [website_url
] era parte del recursoAccount
y el estado del reclamo [website_claimed
] era parte del recursoAccountStatus
). - Métodos detallados: La API de Merchant ofrece métodos específicos para realizar las siguientes acciones:
- Recupera los detalles de la página principal:
accounts.homepage.getHomepage
- Actualiza el URI de la página principal:
accounts.homepage.updateHomepage
- Reclama la página principal:
accounts.homepage.claim
- Rechaza la página principal:
accounts.homepage.unclaim
La API de Content for Shopping usóaccounts.claimwebsite
para la acción de reclamo,accounts.update
para establecer la URL (y, de hecho, rechazarla estableciendo una URL vacía) yaccounts.get
/accountstatuses.get
para recuperar la URL y el estado del reclamo, respectivamente.
- Recupera los detalles de la página principal:
- Información centralizada: El recurso
Homepage
de la API de Merchant contiene directamente el estadoclaimed
y la URL de la página principaluri
. Todos los métodos que operan en el recursoHomepage
devuelven este recurso, lo que proporciona comentarios inmediatos sobre el estado actual. En Content API for Shopping,accounts.claimwebsite
no devolvía el estado actualizado, por lo que se necesitaban llamadas independientes. - Renuncia explícita: En Content API for Shopping, la renuncia se lograba, por lo general, actualizando
Account.website_url
a una cadena vacía. La API de Merchant proporciona un métodohomepage.unclaim
dedicado. - Anular 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 (ajuste 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 (se aplicó la acción en el Account.website_url establecido con accounts.update ) |
POST /accounts/v1/accounts/{account}/homepage:claim |
Cómo rechazar la página principal | accounts.update (configurar Account.website_url en una cadena vacía) |
POST /accounts/v1/accounts/{account}/homepage:unclaim |
Identificadores
Se optimizó la identificación de recursos en la API de Merchant.
Descripción del identificador | Content API for Shopping | API de Merchant |
---|---|---|
Identificador de la cuenta para el acceso a recursos | merchantId (cuenta avanzada) y accountId (cuenta secundaria) en la ruta de acceso |
account (parte del campo name , como accounts/{account_id}/homepage ) |
Identificador del recurso de la página principal | No aplicable (implícito en 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 reclamar, ahora forma parte de un conjunto más amplio de funcionalidades dentro del recurso Homepage
de Merchant API.
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 sobre el uri establecido previamente con homepage.update . Incluye un parámetro overwrite . Devuelve el recurso Homepage con su estado actual uri y claimed . |
accounts.get (para leer Account.website_url ), accountstatuses.get (para leer AccountStatus.website_claimed ) |
accounts.homepage.getHomepage |
Nuevo método dedicado para recuperar la página principal actual uri 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 la página principal uri . |
accounts.update (se configura Account.website_url como una cadena vacía como solución alternativa para anular el reclamo) |
accounts.homepage.unclaim |
Se agregó un nuevo método específico 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 orienta 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 Merchant API corresponde a 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 ) |
Es 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 ) |
Opcional. Si es true , intenta reclamar el sitio web y, posiblemente, quita un reclamo existente de otra cuenta si la cuenta solicitante puede verificar la propiedad. |
Account.website_url (campo en el recurso Account , configurado con accounts.update y leído con accounts.get ) |
Homepage.uri (campo en el recurso Homepage ) |
Es 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 configura con accounts.homepage.updateHomepage y se muestra en todos los métodos Homepage . |
AccountStatus.website_claimed (campo en el recurso AccountStatus , se lee con accountstatuses.get ) |
Homepage.claimed (campo booleano de solo salida en el recurso Homepage ) |
Indica si el uri se reclamó y verificó. Este estado está disponible directamente en el recurso Homepage que devuelven todos sus métodos asociados de la API de Merchant. |
N/A | UpdateHomepageRequest.update_mask (parámetro del cuerpo de la solicitud accounts.homepage.updateHomepage ) |
Máscara de campo opcional para homepage.update que especifica qué campos (p.ej., uri ) del recurso Homepage . |