Startseiteneinstellungen migrieren

Mit der Merchant API wird eine spezielle Homepage-Ressource eingeführt. Diese Ressource bietet neue Methoden zum Verwalten Ihres Anspruchs auf die Startseite, die über die Funktionen der klassischen Content API for Shopping hinausgehen.

Der Zugriff auf Funktionen für Ihren Onlineshop erfolgt in zwei Schritten: Zuerst müssen Sie die Inhaberschaft bestätigen und dann die Website für Ihr Konto beanspruchen. Verwenden Sie für den letzten Schritt die accounts.homepage.claim.

Wichtige Unterschiede

Im Vergleich zur Content API for Shopping gibt es bei der Merchant API mehrere Änderungen in Bezug auf die Startseite:

• Eigene Ressource: Die Merchant API bietet eine separate Homepage-Ressource (accounts.homepage) für alle Startseiten-bezogenen Vorgänge. In der Content API for Shopping haben Sie accounts.claimwebsite verwendet, um die Anspruchsaktion auszuführen. Die Homepage-URL (website_url) war Teil der Account-Ressource und der Anspruchsstatus (website_claimed) war Teil der AccountStatus-Ressource.
• Granulare Methoden: Die Merchant API bietet spezifische Methoden für folgende Aufgaben:
  • Details zur Startseite abrufen: accounts.homepage.getHomepage
  • Aktualisieren Sie den Startseiten-URI: accounts.homepage.updateHomepage
  • Startseite beanspruchen: accounts.homepage.claim
  • Homepage-Anspruch zurückziehen: accounts.homepage.unclaim Content API for Shopping verwendet accounts.claimwebsite für die Anspruchsaktion, accounts.update zum Festlegen der URL (und zum Zurückziehen des Anspruchs durch Festlegen einer leeren URL) und accounts.get/accountstatuses.get zum Abrufen der URL bzw. des Anspruchsstatus.
• Zentrale Informationen: Die Merchant API-Ressource Homepage enthält sowohl die uri (Homepage-URL) als auch den claimed-Status. Alle Methoden, die für die Homepage-Ressource ausgeführt werden, geben diese Ressource zurück. So erhalten Sie sofort Feedback zum aktuellen Status. In der Content API for Shopping wurde der aktualisierte Status nicht von accounts.claimwebsite zurückgegeben. Hier waren separate Aufrufe erforderlich.
• Expliziter Haftungsausschluss: In der Content API for Shopping wurde ein Haftungsausschluss in der Regel durch Aktualisieren von Account.website_url auf einen leeren String erreicht. Die Merchant API bietet eine spezielle Methode homepage.unclaim.
• Anspruch überschreiben: Beide APIs unterstützen während des Anspruchsvorgangs den Parameter overwrite, um einen Anspruch von einem anderen Konto zu übernehmen, wenn das Eigentum bestätigt werden kann.

Anfragen

Die Merchant API verwendet separate RESTful-Endpunkte zum Verwalten verschiedener Aspekte der Startseite.

Beschreibung der Anfrage	Content API for Shopping	Merchant API
Details zur Startseite abrufen	accounts.get (zum Lesen von Account.website_url), accountstatuses.get (zum Lesen von AccountStatus.website_claimed)	GET /accounts/v1/accounts/{account}/homepage
Startseiten-URI aktualisieren	accounts.update (Einstellung Account.website_url)	PATCH /accounts/v1/accounts/{account}/homepage
Startseite beanspruchen oder noch einmal bestätigen	POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (wurde am Account.website_url mit accounts.update festgelegt)	POST /accounts/v1/accounts/{account}/homepage:claim
Startseite ablehnen	accounts.update (Account.website_url wird auf einen leeren String gesetzt)	POST /accounts/v1/accounts/{account}/homepage:unclaim

IDs

Die Ressourcenidentifizierung wurde in der Merchant API optimiert.

Beschreibung der Kennung	Content API for Shopping	Merchant API
Konto-ID für den Ressourcenzugriff	merchantId (erweitertes Konto) und accountId (Unterkonto) im Pfad	account (Teil des Felds name, z. B. accounts/{account_id}/homepage)
Ressourcen-ID der Startseite	Nicht zutreffend (implizit für die Account-Ressource)	name: accounts/{account_id}/homepage (identifiziert die Unterressource Homepage)

Methoden

Die accounts.claimwebsite-Methode aus der Content API for Shopping, die sich auf das Beanspruchen konzentrierte, ist jetzt Teil einer umfassenderen Reihe von Funktionen in der Homepage-Ressource der Merchant API.

Content API for Shopping-Methode	Merchant API-Methode	Verfügbarkeit und Hinweise
accounts.claimwebsite	accounts.homepage.claim	Leitet einen Websiteanspruch direkt ein oder überprüft ihn noch einmal. Die Aktion wird für die uri ausgeführt, die zuvor mit homepage.update festgelegt wurde. Enthält den Parameter overwrite. Gibt die Homepage-Ressource mit dem aktuellen uri- und claimed-Status zurück.
accounts.get (zum Lesen von Account.website_url), accountstatuses.get (zum Lesen von AccountStatus.website_claimed)	accounts.homepage.getHomepage	Es gibt eine neue spezielle Methode, um die aktuelle Startseite uri und ihren claimed-Status in einem einzigen Aufruf abzurufen.
accounts.update (zum Festlegen von Account.website_url)	accounts.homepage.updateHomepage	Neue spezielle Methode zum Festlegen oder Ändern der Startseite uri.
accounts.update (als Workaround zum Aufheben der Anspruchserhebung wird Account.website_url auf einen leeren String gesetzt)	accounts.homepage.unclaim	Neue spezielle Methode zum Aufheben der Inanspruchnahme einer Startseite

Detaillierte Feldänderungen

Die Art und Weise, wie auf Startseiteninformationen zugegriffen wird, hat sich erheblich geändert. Sie werden jetzt explizit über die Homepage-Ressource in der Merchant API abgerufen.

Content API for Shopping	Merchant API	Beschreibung
merchantId (Pfadparameter für accounts.claimwebsite)	name (Pfadparameter für Homepage-Methoden, Format: accounts/{account}/homepage)	Der account-Teil des name-Strings in der Merchant API entspricht dem accountId aus der Content API for Shopping.
accountId (Pfadparameter für accounts.claimwebsite)	name (Pfadparameter für Homepage-Methoden, Format: accounts/{account}/homepage)	Die Kennung für das Konto, dessen Startseite verwaltet wird.
overwrite (boolescher Wert im ContentAccountsClaimwebsiteRequest-Body und AccountsCustomBatchRequestEntry)	ClaimHomepageRequest.overwrite (boolescher Wert im Anfragetext von homepage.claim)	Optional. Wenn true, wird versucht, die Website zu beanspruchen. Dabei wird möglicherweise ein vorhandener Anspruch aus einem anderen Konto entfernt, wenn die Inhaberschaft durch das anfragende Konto bestätigt werden kann.
Account.website_url (Feld in der Account-Ressource, festgelegt mit accounts.update, gelesen mit accounts.get)	Homepage.uri (Feld in der Ressource Homepage)	Die URI (URL) der Startseite des Geschäfts. In der Merchant API ist dies ein explizites Feld in der Ressource Homepage. Sie wird mit accounts.homepage.updateHomepage festgelegt und von allen Homepage-Methoden zurückgegeben.
AccountStatus.website_claimed (Feld in der AccountStatus-Ressource, das mit accountstatuses.get gelesen wird)	Homepage.claimed (boolesches Feld „output_only“ in der Ressource Homepage)	Gibt an, ob das uri beansprucht und bestätigt wurde. Dieser Status ist direkt in der Homepage-Ressource verfügbar, die von allen zugehörigen Merchant API-Methoden zurückgegeben wird.
–	UpdateHomepageRequest.update_mask-Parameter im Anfragetext accounts.homepage.updateHomepage	Eine optionale Feldmaske für homepage.update, mit der angegeben wird, welche Felder (z.B. uri) der Homepage-Ressource aktualisiert werden.