La API de Merchant presenta un recurso Homepage dedicado. Este recurso proporciona métodos nuevos para administrar el reclamo de tu página principal,
lo que ofrece funciones que van más allá de la Content API for Shopping clásica.
Para acceder a las funciones de tu tienda en línea, debes seguir un proceso de dos pasos: primero, verificar
la propiedad y, luego, reclamar 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
Homepagedistinto (accounts.homepage) para todas las operaciones relacionadas con la página principal. (En Content API for Shopping, usasteaccounts.claimwebsitepara realizar la acción de reclamo, la URL de la página principal (website_url) era parte del recursoAccounty el estado del reclamo (website_claimed) era parte del recursoAccountStatus). - Métodos detallados: La API de Merchant ofrece métodos específicos para lo siguiente:
- 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 - Anula el reclamo de la página principal:
accounts.homepage.unclaimContent API for Shopping usóaccounts.claimwebsitepara la acción de reclamo,accounts.updatepara establecer la URL (y anular el reclamo de manera efectiva estableciendo una URL vacía) yaccounts.get/accountstatuses.getpara recuperar la URL y el estado del reclamo, respectivamente.
- Recupera los detalles de la página principal:
- Información centralizada: El recurso
Homepagede la API de Merchant contiene directamente lauri(URL de la página principal) y el estado declaimed. Todos los métodos que operan en el recursoHomepagedevuelven este recurso, lo que proporciona comentarios inmediatos sobre el estado actual. En Content API for Shopping,accounts.claimwebsiteno 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 el
Account.website_urla una cadena vacía. La API de Merchant proporciona un métodohomepage.unclaimdedicado. - Reemplazar reclamo: Ambas APIs admiten un parámetro
overwritedurante 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 de 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 (parámetro 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ó al conjunto Account.website_url con accounts.update) |
POST /accounts/v1/accounts/{account}/homepage:claim |
| Exención de responsabilidad de la página principal | accounts.update (establece 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 los recursos | merchantId (cuenta avanzada) y accountId (cuenta secundaria) 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 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 funciones 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 configurado anteriormente con homepage.update. Incluye un parámetro overwrite. Muestra el recurso Homepage con su estado actual de uri y claimed. |
accounts.get (para leer Account.website_url), accountstatuses.get (para leer AccountStatus.website_claimed) |
accounts.homepage.getHomepage |
Se agregó un 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 |
Se agregó un nuevo método dedicado para establecer o cambiar la página principal uri. |
accounts.update (configura Account.website_url como una cadena vacía como solución alternativa para rechazar el reclamo) |
accounts.homepage.unclaim |
Se agregó un nuevo método dedicado para rechazar explícitamente una página principal. |
Cambios detallados de los campos
La forma en que se estructura la información de la página principal y se accede a ella cambió
significativamente, y se trasladó al recurso explícito Homepage en la API de Merchant.
| Content API for Shopping | API de Merchant | Descripción |
|---|---|---|
merchantId (parámetro de ruta de acceso para accounts.claimwebsite) |
name (parámetro de ruta de acceso 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 de acceso 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, se intenta reclamar el sitio web, lo que podría quitar un reclamo existente de otra cuenta si la cuenta solicitante puede verificar la propiedad. |
Account.website_url (campo en el recurso Account, se establece con accounts.update y se lee 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 lo devuelven todos los métodos Homepage. |
AccountStatus.website_claimed (campo en el recurso AccountStatus, se lee con accountstatuses.get) |
Homepage.claimed (campo booleano output_only en el recurso Homepage) |
Indica si el uri se reclamó y verificó. Este estado está disponible directamente en el recurso Homepage que devuelven todos los métodos asociados de la API de Merchant. |
| N/A | UpdateHomepageRequest.update_mask (parámetro del cuerpo de la solicitud accounts.homepage.updateHomepage) |
Una máscara de campo opcional para que homepage.update especifique qué campos (p.ej., uri) del recurso Homepage se están actualizando. |