Eseguire la migrazione delle impostazioni della home page

L'API Merchant introduce una risorsa Homepage dedicata. Questa risorsa fornisce nuovi metodi per gestire la rivendicazione della tua home page, offrendo funzionalità che vanno oltre l'API Content for Shopping classica.

L'accesso alle funzionalità per il tuo negozio online è un processo in due passaggi: prima la verifica della proprietà, poi la rivendicazione del sito per il tuo account. Per completare il passaggio finale, utilizza accounts.homepage.claim.

Differenze principali

L'API Merchant apporta diverse modifiche relative alla home page rispetto all'API Content for Shopping:

• Risorsa dedicata: l'API Merchant fornisce una risorsa Homepage distinta (accounts.homepage) per tutte le operazioni relative alla home page. (Nell'API Content for Shopping, hai utilizzato accounts.claimwebsite per eseguire l'azione di rivendicazione, l'URL della home page (website_url) faceva parte della risorsa Account e lo stato della rivendicazione (website_claimed) faceva parte della risorsa AccountStatus.)
• Metodi granulari: l'API Merchant offre metodi specifici per:
  • Recupera i dettagli della home page: accounts.homepage.getHomepage
  • Aggiorna l'URI della home page: accounts.homepage.updateHomepage
  • Rivendica la home page: accounts.homepage.claim
  • Rimuovi la rivendicazione della home page: accounts.homepage.unclaim L'API Content for Shopping utilizzava accounts.claimwebsite per l'azione di rivendicazione, accounts.update per impostare l'URL (e rimuovere effettivamente la rivendicazione impostando un URL vuoto) e accounts.get/accountstatuses.get per recuperare rispettivamente l'URL e lo stato della rivendicazione.
• Informazioni centralizzate: la risorsa Homepage dell'API Merchant contiene direttamente sia l'uri (URL della home page) sia lo stato claimed. Tutti i metodi che operano sulla risorsa Homepage restituiscono questa risorsa, fornendo un feedback immediato sullo stato attuale. Nell'API Content for Shopping, accounts.claimwebsite non restituiva lo stato aggiornato; erano necessarie chiamate separate.
• Esclusione di responsabilità esplicita: nell'API Content for Shopping, l'esclusione di responsabilità veniva generalmente ottenuta aggiornando Account.website_url con una stringa vuota. L'API Merchant fornisce un metodo homepage.unclaim dedicato.
• Sovrascrittura della rivendicazione: entrambe le API supportano un parametro overwrite durante la procedura di rivendicazione per acquisire una rivendicazione da un altro account se la proprietà può essere verificata.

Richieste

L'API Merchant utilizza endpoint RESTful distinti per la gestione di diversi aspetti della home page.

Descrizione della richiesta	API Content for Shopping	API Merchant
Visualizza i dettagli della home page	accounts.get (per leggere Account.website_url), accountstatuses.get (per leggere AccountStatus.website_claimed)	GET /accounts/v1/accounts/{account}/homepage
Aggiorna l'URI della home page	accounts.update (impostazione Account.website_url)	PATCH /accounts/v1/accounts/{account}/homepage
Rivendica o verifica nuovamente la home page	POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (azione eseguita sul set Account.website_url utilizzando accounts.update)	POST /accounts/v1/accounts/{account}/homepage:claim
Rinunciare alla home page	accounts.update (impostando Account.website_url su una stringa vuota)	POST /accounts/v1/accounts/{account}/homepage:unclaim

Identificatori

L'identificazione delle risorse è stata semplificata nell'API Merchant.

Descrizione dell'identificatore	API Content per Shopping	API Merchant
Identificatore dell'account per l'accesso alle risorse	merchantId (account avanzato) e accountId (subaccount) nel percorso	account (parte del campo name, ad esempio accounts/{account_id}/homepage)
Identificatore di risorse della home page	Non applicabile (implicito nella risorsa Account)	name: accounts/{account_id}/homepage (identifica la risorsa secondaria Homepage)

Metodi

Il metodo accounts.claimwebsite dell'API Content for Shopping, che si concentrava sull'azione di rivendicazione, ora fa parte di un insieme più ampio di funzionalità all'interno della risorsa Homepage dell'API Merchant.

Metodo API Content for Shopping	Metodo API Merchant	Disponibilità e note
accounts.claimwebsite	accounts.homepage.claim	Avvia o verifica nuovamente una rivendicazione di un sito web. Agisce sul uri impostato in precedenza utilizzando homepage.update. Include un parametro overwrite. Restituisce la risorsa Homepage con lo stato uri e claimed corrente.
accounts.get (per leggere Account.website_url), accountstatuses.get (per leggere AccountStatus.website_claimed)	accounts.homepage.getHomepage	Nuovo metodo dedicato per recuperare la home page corrente uri e il relativo stato claimed in una singola chiamata.
accounts.update (per impostare Account.website_url)	accounts.homepage.updateHomepage	Nuovo metodo dedicato per impostare o modificare la home page uri.
accounts.update (impostazione di Account.website_url su una stringa vuota come soluzione alternativa per annullare la rivendicazione)	accounts.homepage.unclaim	Nuovo metodo dedicato per annullare esplicitamente la rivendicazione di una home page.

Modifiche dettagliate ai campi

Il modo in cui le informazioni della home page sono strutturate e accessibili è cambiato in modo significativo, passando alla risorsa esplicita Homepage nell'API Merchant.

API Content per Shopping	API Merchant	Descrizione
merchantId (parametro di percorso per accounts.claimwebsite)	name (parametro di percorso per i metodi Homepage, formato: accounts/{account}/homepage)	La parte account della stringa name nell'API Merchant corrisponde a accountId dell'API Content for Shopping.
accountId (parametro di percorso per accounts.claimwebsite)	name (parametro di percorso per i metodi Homepage, formato: accounts/{account}/homepage)	L'identificatore dell'account specifico di cui viene gestita la home page.
overwrite (booleano nel corpo ContentAccountsClaimwebsiteRequest e AccountsCustomBatchRequestEntry)	ClaimHomepageRequest.overwrite (booleano nel corpo della richiesta homepage.claim)	Facoltativo. Se true, tenta di rivendicare il sito web, rimuovendo potenzialmente una rivendicazione esistente da un altro account se la proprietà può essere verificata dall'account richiedente.
Account.website_url (campo nella risorsa Account, impostato utilizzando accounts.update, letto utilizzando accounts.get)	Homepage.uri (campo nella risorsa Homepage)	L'URI (URL) della home page del negozio. Nell'API Merchant, questo è un campo esplicito all'interno della risorsa Homepage. Viene impostato utilizzando accounts.homepage.updateHomepage e restituito da tutti i metodi Homepage.
AccountStatus.website_claimed (campo nella risorsa AccountStatus, letto utilizzando accountstatuses.get)	Homepage.claimed (campo booleano output_only nella risorsa Homepage)	Indica se l'entità uri è stata rivendicata e verificata. Questo stato è direttamente disponibile nella risorsa Homepage restituita da tutti i metodi dell'API Merchant associati.
N/D	UpdateHomepageRequest.update_mask parametro del corpo della richiesta accounts.homepage.updateHomepage)	Una maschera di campo facoltativa per homepage.update per specificare quali campi (ad es. uri) della risorsa Homepage vengono aggiornati.