Die Merchant API führt eine dedizierte Homepage-Ressource ein. Diese Ressource bietet neue Methoden zum Verwalten des Anspruchs auf Ihre Startseite und bietet Funktionen, die über die klassische Content API for Shopping hinausgehen.
Der Zugriff auf Funktionen für Ihren Onlineshop erfolgt in zwei Schritten: Zuerst bestätigen Sie die Inhaberschaft und dann beanspruchen Sie die Website für Ihr Konto. Verwenden Sie für den letzten Schritt die accounts.homepage.claim.
Wichtige Unterschiede
Die Merchant API bietet im Vergleich zur Content API for Shopping 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 Website. (In der Content API for Shopping haben Sieaccounts.claimwebsiteverwendet, um die Beanspruchung durchzuführen. Die URL der Startseite (website_url) war Teil der RessourceAccountund der Status der Beanspruchung (website_claimed) war Teil der RessourceAccountStatus.) - Detaillierte Methoden: Die Merchant API bietet spezifische Methoden für Folgendes:
- Details zur Startseite abrufen:
accounts.homepage.getHomepage - Aktualisieren Sie den Homepage-URI:
accounts.homepage.updateHomepage - Anspruch auf die Startseite erheben:
accounts.homepage.claim - Anspruch auf die Startseite aufheben:
accounts.homepage.unclaimIn der Content API for Shopping wirdaccounts.claimwebsitefür die Anspruchsaktion verwendet,accounts.updatezum Festlegen der URL (und zum Aufheben des Anspruchs durch Festlegen einer leeren URL) undaccounts.get/accountstatuses.getzum Abrufen der URL bzw. des Anspruchsstatus.
- Details zur Startseite abrufen:
- Zentral gespeicherte Informationen: Die Merchant API-Ressource
Homepageenthält sowohl dieuri(URL der Startseite) als auch denclaimed-Status direkt. Alle Methoden, die auf der RessourceHomepageausgeführt werden, geben diese Ressource zurück und liefern sofortiges Feedback zum aktuellen Status. In der Content API for Shopping hataccounts.claimwebsiteden aktualisierten Status nicht zurückgegeben. Es waren separate Aufrufe erforderlich. - Expliziter Ausschluss: In der Content API for Shopping wurde der Ausschluss in der Regel durch Aktualisieren des
Account.website_urlauf einen leeren String erreicht. Die Merchant API bietet eine speziellehomepage.unclaim-Methode. - Anspruch überschreiben: Beide APIs unterstützen während des Anspruchsprozesses einen
overwrite-Parameter, um einen Anspruch von einem anderen Konto zu übernehmen, wenn die Eigentümerschaft bestätigt werden kann.
Anfragen
Die Merchant API verwendet separate RESTful-Endpunkte, um verschiedene Aspekte der Website zu verwalten.
| 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 |
| Homepage-URI aktualisieren | accounts.update (Einstellung Account.website_url) |
PATCH /accounts/v1/accounts/{account}/homepage |
| Homepage beanspruchen oder noch einmal bestätigen | POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (Aktion für Account.website_url-Satz mit accounts.update) |
POST /accounts/v1/accounts/{account}/homepage:claim |
| Haftungsausschluss für die Startseite | accounts.update (Account.website_url wird auf einen leeren String gesetzt) |
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) |
| Ressourcenkennung der Startseite | Nicht zutreffend (implizit für Account-Ressource) |
name: accounts/{account_id}/homepage (identifiziert die Unterressource Homepage) |
Methoden
Die Methode accounts.claimwebsite der Content API for Shopping, die sich auf die Aktion des Beanspruchens konzentrierte, ist jetzt Teil einer größeren Gruppe von Funktionen innerhalb der Ressource Homepage der Merchant API.
| Content API for Shopping-Methode | Merchant API-Methode | Verfügbarkeit und Hinweise |
|---|---|---|
accounts.claimwebsite |
accounts.homepage.claim |
Initiiert oder bestätigt einen Websiteanspruch direkt. Wird auf die uri angewendet, die zuvor mit homepage.update festgelegt wurde. Enthält einen overwrite-Parameter. 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 |
Neue dedizierte Methode zum Abrufen der aktuellen Startseite uri und ihres claimed-Status in einem einzigen Aufruf. |
accounts.update (zum Festlegen von Account.website_url) |
accounts.homepage.updateHomepage |
Neue dedizierte Methode zum Festlegen oder Ändern der Startseite uri. |
accounts.update (Account.website_url wird auf einen leeren String gesetzt, um den Anspruch aufzuheben) |
accounts.homepage.unclaim |
Neue dedizierte Methode, um explizit keinen Anspruch mehr auf eine Startseite zu erheben. |
Detaillierte Feldänderungen
Die Art und Weise, wie Informationen auf der Startseite strukturiert und abgerufen werden, hat sich erheblich geändert. In der Merchant API wird jetzt die explizite Ressource Homepage verwendet.
| Content API for Shopping | Merchant API | Beschreibung |
|---|---|---|
merchantId (Pfadparameter für accounts.claimwebsite) |
name (Pfadparameter für Homepage-Methoden, Format: accounts/{account}/homepage) |
Der Teil account des Strings name in der Merchant API entspricht der 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 spezifische Konto, dessen Startseite verwaltet wird. |
overwrite (boolesch im ContentAccountsClaimwebsiteRequest-Text und AccountsCustomBatchRequestEntry) |
ClaimHomepageRequest.overwrite (boolescher Wert im homepage.claim-Anfragetext) |
Optional. Wenn true, wird versucht, die Website zu beanspruchen. Dabei wird möglicherweise ein bestehender Anspruch eines anderen Kontos 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 Homepage-Ressource) |
Der URI (URL) der Startseite des Geschäfts. In der Merchant API ist dies ein explizites Feld in der Homepage-Ressource. Sie wird mit accounts.homepage.updateHomepage festgelegt und von allen Homepage-Methoden zurückgegeben. |
AccountStatus.website_claimed (Feld in der AccountStatus-Ressource, gelesen mit accountstatuses.get) |
Homepage.claimed (boolesches Feld „output_only“ in der Ressource Homepage) |
Gibt an, ob die 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 accounts.homepage.updateHomepage-Anfragetextparameter) |
Eine optionale Feldmaske für homepage.update, um anzugeben, welche Felder (z.B. uri) der Homepage-Ressource aktualisiert werden. |