Migracja ustawień strony głównej

Interfejs Merchant API wprowadza dedykowany zasób Homepage. Ten zasób udostępnia nowe metody zarządzania roszczeniem do strony głównej, które oferują funkcje wykraczające poza klasyczny interfejs Content API for Shopping.

Dostęp do funkcji sklepu internetowego to proces dwuetapowy: najpierw musisz potwierdzić własność, a następnie zgłosić prawa do witryny na swoim koncie. Aby wykonać ostatni krok, użyj accounts.homepage.claim.

Najważniejsze różnice

W porównaniu z Content API for Shopping Merchant API wprowadza kilka zmian związanych ze stroną główną:

• Dedykowany zasób: interfejs Merchant API udostępnia odrębny zasób Homepage (accounts.homepage) do wszystkich operacji związanych ze stroną główną. (W Content API for Shopping do wykonania działania związanego z roszczeniem używano znaku accounts.claimwebsite, adres URL strony głównej (website_url) był częścią zasobu Account, a stan roszczenia (website_claimed) był częścią zasobu AccountStatus).
• Metody szczegółowe: interfejs Merchant API oferuje konkretne metody, które umożliwiają:
  • Pobieranie szczegółów strony głównej: accounts.homepage.getHomepage
  • Zaktualizuj identyfikator URI strony głównej: accounts.homepage.updateHomepage
  • Przejmij stronę główną: accounts.homepage.claim
  • Zrzeczenie się praw do strony głównej: accounts.homepage.unclaim interfejs Content API for Shopping używał accounts.claimwebsite do działania związanego z roszczeniem, accounts.update do ustawiania adresu URL (i skutecznego zrzeczenia się praw przez ustawienie pustego adresu URL) oraz accounts.get/accountstatuses.get do pobierania adresu URL i stanu roszczenia.
• Scentralizowane informacje: zasób Merchant API Homepage zawierauri zarówno adres URL strony głównej, jak i claimed stan. Wszystkie metody działające na zasobie Homepage zwracają ten zasób, co zapewnia natychmiastową informację zwrotną o jego aktualnym stanie. W Content API for Shopping interfejs APIaccounts.claimwebsite nie zwracał zaktualizowanego stanu, więc konieczne były oddzielne wywołania.
• Wyraźne wyłączenie odpowiedzialności: w Content API for Shopping wyłączenie odpowiedzialności było zwykle osiągane przez zaktualizowanie pola Account.website_url do pustego ciągu znaków. Interfejs Merchant API udostępnia specjalną metodę homepage.unclaim.
• Zastąpienie roszczenia: oba interfejsy API obsługują parametr overwrite podczas procesu zgłaszania roszczenia, który umożliwia przejęcie roszczenia z innego konta, jeśli można potwierdzić prawo własności.

Żądania

Interfejs Merchant API używa różnych punktów końcowych RESTful do zarządzania różnymi aspektami strony głównej.

Opis prośby	Content API for Shopping	Merchant API
Wyświetlanie szczegółów strony głównej	accounts.get (do odczytu Account.website_url), accountstatuses.get (do odczytu AccountStatus.website_claimed)	GET /accounts/v1/accounts/{account}/homepage
Aktualizowanie identyfikatora URI strony głównej	accounts.update (ustawienie Account.website_url)	PATCH /accounts/v1/accounts/{account}/homepage
Zgłaszanie praw do strony głównej lub ponowne weryfikowanie jej	POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (działanie podjęte Account.website_url, ustawione za pomocą accounts.update)	POST /accounts/v1/accounts/{account}/homepage:claim
Wyłączenie odpowiedzialności za stronę główną	accounts.update (ustawienie Account.website_url na pusty ciąg znaków)	POST /accounts/v1/accounts/{account}/homepage:unclaim

Identyfikatory

Identyfikacja zasobów w Merchant API została uproszczona.

Opis identyfikatora	Content API for Shopping	Merchant API
Identyfikator konta na potrzeby dostępu do zasobów	merchantId (konto zaawansowane) i accountId (subkonto) w ścieżce.	account (część pola name, np. accounts/{account_id}/homepage)
Identyfikator zasobu strony głównej	Nie dotyczy (implikacja zasobu Account)	name: accounts/{account_id}/homepage (identyfikuje zasób podrzędny Homepage)

Metody

Metoda accounts.claimwebsite z Content API for Shopping, która była skupiona na działaniu związanym z roszczeniem, jest teraz częścią szerszego zestawu funkcji w ramach zasobu Homepage Merchant API.

Metoda Content API for Shopping	Metoda Merchant API	Dostępność i uwagi
accounts.claimwebsite	accounts.homepage.claim	bezpośrednio inicjuje lub ponownie weryfikuje zgłoszenie praw do witryny; Działa na uri ustawionym wcześniej za pomocą homepage.update. Zawiera parametr overwrite. Zwraca zasób Homepage z bieżącym stanem uri i claimed.
accounts.get (do odczytu Account.website_url), accountstatuses.get (do odczytu AccountStatus.website_claimed)	accounts.homepage.getHomepage	Nowa metoda pobierania bieżącej strony głównej uri i jej claimed stanu w ramach jednego wywołania.
accounts.update (aby ustawić Account.website_url)	accounts.homepage.updateHomepage	Nowa metoda ustawiania lub zmieniania strony głównejuri.
accounts.update (ustawienie Account.website_url na pusty ciąg znaków jako obejście problemu z wycofaniem roszczenia)	accounts.homepage.unclaim	Nowa metoda, która umożliwia wyraźne wycofanie roszczenia do strony głównej.

Szczegółowe zmiany w polach

Sposób strukturyzacji informacji na stronie głównej i uzyskiwania do nich dostępu uległ znacznym zmianom. Został on przeniesiony do jawnego zasobu Homepage w Merchant API.

Content API for Shopping	Merchant API	Opis
merchantId (parametr ścieżki dla accounts.claimwebsite)	name (parametr ścieżki dla metod Homepage, format: accounts/{account}/homepage)	Część account ciągu name w Merchant API odpowiada części accountId w Content API for Shopping.
accountId (parametr ścieżki dla accounts.claimwebsite)	name (parametr ścieżki dla metod Homepage, format: accounts/{account}/homepage)	Identyfikator konkretnego konta, którego strona główna jest zarządzana.
overwrite (wartość logiczna w treści ContentAccountsClaimwebsiteRequest i AccountsCustomBatchRequestEntry)	ClaimHomepageRequest.overwrite (wartość logiczna w treści żądania homepage.claim)	Opcjonalnie. Jeśli true, próbuje zgłosić prawa do witryny, co może spowodować usunięcie istniejącego zgłoszenia z innego konta, jeśli konto wysyłające prośbę może potwierdzić własność.
Account.website_url (pole w zasobie Account, ustawiane za pomocą accounts.update, odczytywane za pomocą accounts.get)	Homepage.uri (pole w zasobie Homepage)	Identyfikator URI (URL) strony głównej sklepu. W Merchant API jest to jawne pole w zasobie Homepage. Jest ona ustawiana za pomocą accounts.homepage.updateHomepage i zwracana przez wszystkie metody Homepage.
AccountStatus.website_claimed (pole w zasobie AccountStatus, odczytywane za pomocą accountstatuses.get)	Homepage.claimed (pole logiczne tylko do odczytu w zasobie Homepage)	Wskazuje, czy uri jest zgłoszony i zweryfikowany. Ten stan jest dostępny bezpośrednio w zasobie Homepage zwracanym przez wszystkie powiązane z nim metody Merchant API.
Nie dotyczy	UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage parametr treści żądania)	Opcjonalna maska pola dla homepage.update, która określa, które pola (np. uri) zasobu Homepage.