Startseiteneinstellungen migrieren

In der Merchant API wird die dedizierte Homepage Ressource eingeführt. Diese Ressource bietet neue Methoden zum Verwalten Ihres Anspruchs auf die Startseite und bietet mehr Möglichkeiten als die klassische Content API for Shopping.

Der Zugriff auf Funktionen für Ihren Onlineshop erfolgt in zwei Schritten: Zuerst müssen Sie das Inhaberverhältnis 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 in der Merchant API mehrere Änderungen im Zusammenhang mit der Startseite:

• Dedizierte Ressource: Die Merchant API bietet eine separate Homepage Ressource (accounts.homepage) für alle Vorgänge im Zusammenhang mit der Startseite. In der Content API for Shopping haben Sie accounts.claimwebsite verwendet, um den Anspruch zu erheben. Die URL der Startseite (website_url) war Teil der Account Ressource und der Status des Anspruchs (website_claimed) war Teil der AccountStatus Ressource.
• Granulare Methoden: Die Merchant API bietet spezifische Methoden für folgende Vorgänge:
  • Details zur Startseite abrufen: accounts.homepage.getHomepage
  • URI der Startseite aktualisieren: accounts.homepage.updateHomepage
  • Startseite beanspruchen: accounts.homepage.claim
  • Anspruch auf die Startseite aufheben: accounts.homepage.unclaim In der Content API for Shopping wurde accounts.claimwebsite für den Anspruch verwendet, accounts.update zum Festlegen der URL (und zum Aufheben des Anspruchs durch Festlegen einer leeren URL) und accounts.get/accountstatuses.get zum Abrufen der URL bzw. des Status des Anspruchs.
• Zentrale Informationen: Die Ressource Homepage der Merchant API enthält sowohl den uri (die URL der Startseite) als auch den Status claimed. Alle Methoden, die für die Ressource Homepage ausgeführt werden, geben diese Ressource zurück und liefern so sofort Feedback zum aktuellen Status. In der Content API for Shopping hat accounts.claimwebsite den aktualisierten Status nicht zurückgegeben. Separate Aufrufe waren erforderlich.
• Expliziter Anspruch: In der Content API for Shopping wurde der Anspruch in der Regel aufgehoben, indem die Account.website_url auf einen leeren String aktualisiert wurde. Die Merchant API bietet eine dedizierte homepage.unclaim Methode.
• Anspruch überschreiben: Beide APIs unterstützen einen overwrite Parameter während des Anspruchsprozesses, um einen Anspruch von einem anderen Konto zu übernehmen, wenn das Inhaberverhältnis 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
URI der Startseite aktualisieren	accounts.update (Festlegen von Account.website_url)	PATCH /accounts/v1/accounts/{account}/homepage
Startseite beanspruchen oder noch einmal bestätigen	POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (für Account.website_url, festgelegt mit accounts.update)	POST /accounts/v1/accounts/{account}/homepage:claim
Anspruch auf die Startseite aufheben	accounts.update (Festlegen von Account.website_url auf einen leeren String)	POST /accounts/v1/accounts/{account}/homepage:unclaim

IDs

Die Ressourcenidentifikation wurde in der Merchant API optimiert.

Beschreibung der ID	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 Ressource Account)	name: accounts/{account_id}/homepage (identifiziert die Unterressource Homepage)

Methoden

Die Methode accounts.claimwebsite aus der Content API for Shopping, die sich auf die Aktion des Anspruchs konzentrierte, ist jetzt Teil einer breiteren Palette von Funktionen in der Ressource Homepage der Merchant API.

Content API for Shopping-Methode	Merchant API-Methode	Verfügbarkeit und Hinweise
accounts.claimwebsite	accounts.homepage.claim	Leitet direkt einen Anspruch auf eine Website ein oder bestätigt ihn noch einmal. Wirkt sich auf den uri aus, der zuvor mit homepage.update festgelegt wurde. Enthält einen overwrite-Parameter. Gibt die Ressource Homepage mit dem aktuellen uri und dem Status claimed zurück.
accounts.get (zum Lesen von Account.website_url), accountstatuses.get (zum Lesen von AccountStatus.website_claimed)	accounts.homepage.getHomepage	Neue dedizierte Methode zum Abrufen des aktuellen uri der Startseite und des Status claimed in einem einzigen Aufruf.
accounts.update (zum Festlegen von Account.website_url)	accounts.homepage.updateHomepage	Neue dedizierte Methode zum Festlegen oder Ändern des uri der Startseite.
accounts.update (Festlegen von Account.website_url auf einen leeren String als Umgehungslösung zum Aufheben des Anspruchs)	accounts.homepage.unclaim	Neue dedizierte Methode zum expliziten Aufheben des Anspruchs auf eine Startseite.

Detaillierte Feldänderungen

Die Strukturierung und der Zugriff auf Informationen zur Startseite haben sich erheblich geändert und bewegen sich in Richtung der expliziten Ressource Homepage in der Merchant API.

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 accountId aus der Content API for Shopping.
accountId (Pfadparameter für accounts.claimwebsite)	name (Pfadparameter für Homepage-Methoden, Format: accounts/{account}/homepage)	Die ID für das Konto, dessen Startseite verwaltet wird.
overwrite (boolescher Wert im Text von ContentAccountsClaimwebsiteRequest und AccountsCustomBatchRequestEntry)	ClaimHomepageRequest.overwrite (boolescher Wert im Text der Anfrage homepage.claim)	Optional. Wenn true, wird versucht, die Website zu beanspruchen. Dabei wird möglicherweise ein vorhandener Anspruch von einem anderen Konto entfernt, wenn das Inhaberverhältnis vom anfragenden Konto bestätigt werden kann.
Account.website_url (Feld in der Ressource Account, festgelegt mit accounts.update, gelesen mit accounts.get)	Homepage.uri (Feld in der Ressource Homepage)	Der URI (die URL) der Startseite des Shops. In der Merchant API ist dies ein explizites Feld in der Ressource Homepage. Es wird mit accounts.homepage.updateHomepage festgelegt und von allen Homepage Methoden zurückgegeben.
AccountStatus.website_claimed (Feld in der Ressource AccountStatus, gelesen mit accountstatuses.get)	Homepage.claimed (boolesches Feld vom Typ „Nur Ausgabe“ in der Ressource Homepage)	Gibt an, ob der uri beansprucht und bestätigt wurde. Dieser Status ist direkt in der Ressource Homepage verfügbar, die von allen zugehörigen Merchant API-Methoden zurückgegeben wird.
–	UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage Parameter im Text der Anfrage)	Eine optionale Feldmaske für homepage.update, um anzugeben, welche Felder (z.B. uri) der Ressource Homepage aktualisiert werden.