Migracja ustawień strony głównej

Merchant API wprowadza specjalny zasób Homepage. Ten zasób udostępnia nowe metody zarządzania prawem własności do strony głównej, oferując możliwości wykraczające poza klasyczny interfejs Content API for Shopping.

Uzyskiwanie dostępu 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 interfejs Merchant API wprowadza kilka zmian związanych ze stroną główną:

• Specjalny zasób: Merchant API udostępnia osobny zasób Homepage (accounts.homepage) dla wszystkich operacji związanych ze stroną główną. (W Content API for Shopping do zgłaszania praw używana była metoda accounts.claimwebsite, adres URL strony głównej (website_url) był częścią zasobu Account, a stan zgłoszenia (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
  • Zgłoś prawa do strony głównej: accounts.homepage.claim
  • Zrzeczenie się praw do strony głównej: accounts.homepage.unclaim Interfejs Content API for Shopping używa metody accounts.claimwebsite do zgłaszania praw, metody accounts.update do ustawiania adresu URL (i skutecznego zrzeczenia się praw przez ustawienie pustego adresu URL) oraz metod accounts.get/accountstatuses.get do pobierania adresu URL i stanu praw.
• Scentralizowane informacje: zasób Merchant API Homepage zawiera bezpośrednio zarówno uri (adres URL strony głównej), jak i stan claimed. Wszystkie metody działające na zasobie Homepage zwracają ten zasób, co zapewnia natychmiastową informację o bieżącym stanie. W Content API for Shopping metoda accounts.claimwebsite nie zwracała zaktualizowanego stanu, co wymagało osobnych wywołań.
• Wyraźne zrzeczenie się: w Content API for Shopping zrzeczenie się zwykle polegało na zaktualizowaniu pola Account.website_url do pustego ciągu znaków. Merchant API udostępnia specjalną metodę homepage.unclaim.
• Zastępowanie roszczenia: oba interfejsy API obsługują parametr overwrite podczas procesu zgłaszania roszczenia, aby przejąć roszczenie z innego konta, jeśli można zweryfikować własność.

Żądania

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
Pobieranie szczegółów strony głównej	accounts.get (aby odczytać Account.website_url), accountstatuses.get (aby odczytać 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 jej ponowna weryfikacja	POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (podjęto działanie Account.website_url, ustawiono za pomocą: accounts.update)	POST /accounts/v1/accounts/{account}/homepage:claim
Zrzeczenie się strony głównej	accounts.update (ustawienie Account.website_url na pusty ciąg znaków)	POST /accounts/v1/accounts/{account}/homepage:unclaim

Identyfikatory

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

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 (domyślne dla zasobu Account)	name: accounts/{account_id}/homepage (identyfikuje zasób podrzędny Homepage)

Metody

Metoda accounts.claimwebsite z interfejsu Content API for Shopping, która koncentrowała się na działaniu zgłaszania praw, jest teraz częścią szerszego zestawu funkcji w zasobie Homepage interfejsu Merchant API.

Metoda Content API for Shopping	Metoda interfejsu 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 (odczyt: Account.website_url), accountstatuses.get (odczyt: AccountStatus.website_claimed)	accounts.homepage.getHomepage	Nowa specjalna metoda pobierania bieżącej strony głównej uri i jej stanu claimed w ramach jednego wywołania.
accounts.update (aby ustawić Account.website_url)	accounts.homepage.updateHomepage	Nowa specjalna metoda ustawiania lub zmieniania strony głównej: uri.
accounts.update (ustawienie Account.website_url na pusty ciąg znaków jako obejście problemu z usunięciem rezerwacji)	accounts.homepage.unclaim	Nowa specjalna metoda umożliwiająca jawne usunięcie rezerwacji strony głównej.

Szczegółowe zmiany w polach

Sposób, w jaki informacje na stronie głównej są uporządkowane i dostępne, znacznie się zmienił i zbliżył do zasobu Homepage w interfejsie 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 znaków name w interfejsie Merchant API odpowiada accountId z interfejsu 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 własność może zostać zweryfikowana przez konto, które wysłało prośbę.
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 wyraźne pole w zasobie Homepage. Jest ustawiany za pomocą accounts.homepage.updateHomepage i zwracany przez wszystkie metody Homepage.
AccountStatus.website_claimed (pole w zasobie AccountStatus, odczytywane za pomocą accountstatuses.get)	Homepage.claimed (pole logiczne output_only w zasobie Homepage)	Wskazuje, czy uri jest zgłoszony i zweryfikowany. Ten stan jest bezpośrednio dostępny w zasobie Homepage zwracanym przez wszystkie powiązane z nim metody interfejsu Merchant API.
Nie dotyczy	UpdateHomepageRequest.update_mask parametr treści żądania accounts.homepage.updateHomepage)	Opcjonalna maska pola dla homepage.update, która określa, które pola (np. uri) zasobu Homepage są aktualizowane.