Migracja ustawień strony głównej

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

Dostęp do funkcji sklepu internetowego to proces dwuetapowy: najpierw musisz potwierdzić własność, a potem zgłosić witrynę na swoje konto. 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ą:

  • 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 zgłoszenia używano metody 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
    • aktualizowanie identyfikatora URI strony głównej: accounts.homepage.updateHomepage
    • zgłaszanie strony głównej: accounts.homepage.claim
    • wycofywanie zgłoszenia strony głównej: accounts.homepage.unclaim W Content API for Shopping do wykonania działania zgłoszenia używano metody accounts.claimwebsite, do ustawienia adresu URL (i skutecznego wycofania zgłoszenia przez ustawienie pustego adresu URL) – metody accounts.update, a do pobierania adresu URL i stanu zgłoszenia – odpowiednio metod accounts.get/accountstatuses.get.
  • Scentralizowane informacje: zasób Homepage interfejsu Merchant API 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, dlatego konieczne było wykonanie osobnych wywołań.
  • Jawne wycofanie zgłoszenia: w Content API for Shopping wycofanie zgłoszenia zwykle polegało na zaktualizowaniu pola Account.website_url do pustego ciągu znaków. Interfejs Merchant API udostępnia dedykowaną homepage.unclaim metodę.
  • Zastępowanie zgłoszenia: oba interfejsy API obsługują parametr overwrite podczas procesu zgłaszania, który umożliwia przejęcie zgłoszenia z innego konta, jeśli można potwierdzić własność.

Żądania

Interfejs Merchant API używa odrębnych 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 (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 lub ponowne weryfikowanie strony głównej POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (działa na Account.website_url ustawionym za pomocą accounts.update) POST /accounts/v1/accounts/{account}/homepage:claim
Wycofywanie zgłoszenia strony głównej accounts.update (ustawienie Account.website_url na pusty ciąg znaków) POST /accounts/v1/accounts/{account}/homepage:unclaim

Identyfikatory

W interfejsie Merchant API uproszczono identyfikację zasobów.

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

Metody

Metoda accounts.claimwebsite z Content API for Shopping, która koncentrowała się na działaniu zgłaszania, jest teraz częścią szerszego zestawu funkcji w zasobie Homepage interfejsu 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 witryny. Działa na uri ustawionym wcześniej za pomocą homepage.update. Zawiera parametr overwrite. Zwraca zasób Homepage z jego bieżącym stanem uri i claimed.
accounts.get (do odczytu Account.website_url), accountstatuses.get (do odczytu AccountStatus.website_claimed) accounts.homepage.getHomepage Nowa dedykowana metoda pobierania bieżącego uri strony głównej i jej stanu claimed w jednym wywołaniu.
accounts.update (do ustawienia Account.website_url) accounts.homepage.updateHomepage Nowa dedykowana metoda ustawiania lub zmieniania uri strony głównej.
accounts.update (ustawienie Account.website_url na pusty ciąg znaków jako obejście problemu z usunięciem rezerwacji) accounts.homepage.unclaim Nowa dedykowana metoda jawnego wycofania zgłoszenia strony głównej.

Szczegółowe zmiany pól

Sposób strukturyzacji informacji o stronie głównej i uzyskiwania do nich dostępu uległ znacznym zmianom, zmierzając w kierunku jawnego 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 name w interfejsie Merchant API odpowiada accountId z 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 stroną główną zarządzasz.
overwrite (wartość logiczna w treści ContentAccountsClaimwebsiteRequest i AccountsCustomBatchRequestEntry) ClaimHomepageRequest.overwrite (wartość logiczna w treści żądania homepage.claim) Opcjonalnie. Jeśli ma wartość true, próbuje zgłosić witrynę, potencjalnie usuwając istniejące zgłoszenie z innego konta, jeśli konto wysyłające żądanie 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 (adres URL) strony głównej sklepu. W interfejsie Merchant API jest to jawne pole w zasobie Homepage. Jest ustawiane za pomocą accounts.homepage.updateHomepage i zwracane 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 interfejsu 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 są aktualizowane.
Wstecz
Migrate user and access management
Dalej
Migrate region management