API для продавцов представляет собой специальный ресурс Homepage . Этот ресурс предоставляет новые методы для управления вашей заявкой на главную страницу, предлагая возможности, выходящие за рамки классического Content API для покупок.
Доступ к функциям вашего интернет-магазина состоит из двух этапов: сначала подтверждение права собственности, затем регистрация сайта в вашей учетной записи. Для завершения заключительного этапа используйте accounts.homepage.claim .
Ключевые отличия
Merchant API makes several homepage-related changes as compared to Content API for Shopping:
- Выделенный ресурс : API для продавцов предоставляет отдельный ресурс
Homepage(accounts.homepage) для всех операций, связанных с главной страницей. (В Content API для покупок для выполнения действия по подтверждению права собственности использовалсяaccounts.claimwebsite, URL главной страницы (website_url) был частью ресурсаAccount», а статус подтверждения права собственности (website_claimed) — частью ресурсаAccountStatus.) - Granular methods : Merchant API offers specific methods to:
- Получить сведения о главной странице:
accounts.homepage.getHomepage - Update the homepage URI:
accounts.homepage.updateHomepage - Заявите права на главную страницу:
accounts.homepage.claim - Отмена авторизации на главной странице:
accounts.homepage.unclaimAPI контента для покупок использовалaccounts.claimwebsiteдля действия авторизации,accounts.updateдля установки URL (и, по сути, отмены авторизации путем установки пустого URL), аaccounts.get/accountstatuses.getдля получения URL и статуса авторизации соответственно.
- Получить сведения о главной странице:
- Централизованная информация : ресурс
Homepageв API продавца содержит какuri(URL главной страницы), так и статусclaimed. Все методы, работающие с ресурсомHomepage, возвращают этот ресурс, обеспечивая немедленную обратную связь о текущем состоянии. В Content API для покупок методaccounts.claimwebsiteне возвращал обновленный статус; требовались отдельные вызовы. - Явное предупреждение : В Content API для покупок предупреждение обычно устанавливалось путем замены
Account.website_urlна пустую строку. Merchant API предоставляет специальный методhomepage.unclaim. - Overwrite claim : Both APIs support an
overwriteparameter during the claim process to take over a claim from another account if ownership can be verified.
Запросы
Merchant API uses distinct RESTful endpoints for managing different aspects of the homepage.
| Описание запроса | API контента для покупок | API для продавцов |
|---|---|---|
| Получите подробную информацию о главной странице. | accounts.get (для чтения Account.website_url ), accountstatuses.get (для чтения AccountStatus.website_claimed ) | GET /accounts/v1/accounts/{account}/homepage |
| Обновите URI главной страницы | accounts.update (setting Account.website_url ) | PATCH /accounts/v1/accounts/{account}/homepage |
| Подтвердите или повторно проверьте главную страницу. | POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (acted on Account.website_url set using accounts.update ) | POST /accounts/v1/accounts/{account}/homepage:claim |
| Отказ от ответственности на главной странице | accounts.update (setting Account.website_url to an empty string) | POST /accounts/v1/accounts/{account}/homepage:unclaim |
Идентификаторы
Resource identification has been streamlined in Merchant API.
| Описание идентификатора | API контента для покупок | API для продавцов |
|---|---|---|
| Идентификатор учетной записи для доступа к ресурсам | merchantId (advanced account) and accountId (sub-account) in the path | account (часть поля name , например, accounts/{account_id}/homepage ) |
| Идентификатор ресурса главной страницы | Неприменимо (неявно относится к ресурсу Account ») | name : accounts/{account_id}/homepage (identifies the Homepage sub-resource) |
Методы
Метод accounts.claimwebsite из Content API for Shopping, который ранее был ориентирован на действие подтверждения права собственности, теперь является частью более широкого набора функций в ресурсе Homepage Merchant API.
| API контента для метода покупок | Метод API продавца | Наличие и примечания |
|---|---|---|
accounts.claimwebsite | accounts.homepage.claim | Непосредственно инициирует или повторно проверяет утверждение веб-сайта. Действует на основе uri , ранее установленного с помощью homepage.update . Включает параметр overwrite . Возвращает ресурс Homepage с его текущим uri и статусом claimed . |
accounts.get (to read Account.website_url ), accountstatuses.get (to read AccountStatus.website_claimed ) | accounts.homepage.getHomepage | Новый специализированный метод для получения текущего uri главной страницы и ее статуса claimed за один вызов. |
accounts.update (для установки Account.website_url ) | accounts.homepage.updateHomepage | New dedicated method to set or change the homepage uri . |
accounts.update (setting Account.website_url to empty string as a workaround to unclaim) | accounts.homepage.unclaim | New dedicated method to explicitly unclaim a homepage. |
Подробные изменения полей
The way homepage information is structured and accessed has changed significantly, moving towards the explicit Homepage resource in Merchant API.
| API контента для покупок | API для продавцов | Описание |
|---|---|---|
merchantId (path parameter for accounts.claimwebsite ) | name (параметр пути для методов Homepage , формат: accounts/{account}/homepage ) | The account part of the name string in Merchant API corresponds to the accountId from Content API for Shopping. |
accountId (path parameter for accounts.claimwebsite ) | name (path parameter for Homepage methods, format: accounts/{account}/homepage ) | Идентификатор конкретной учетной записи, чья домашняя страница находится в процессе управления. |
overwrite (логическое значение в теле запроса ContentAccountsClaimwebsiteRequest и AccountsCustomBatchRequestEntry ) | ClaimHomepageRequest.overwrite (логическое значение в теле запроса homepage.claim ) | Optional. If true , attempts to claim the website, potentially removing an existing claim from another account if ownership can be verified by the requesting account. |
Account.website_url (field in Account resource, set using accounts.update , read using accounts.get ) | Homepage.uri (поле в ресурсе Homepage ) | URI (URL) главной страницы магазина. В Merchant API это явное поле в ресурсе Homepage . Оно устанавливается с помощью accounts.homepage.updateHomepage и возвращается всеми методами Homepage . |
AccountStatus.website_claimed (field in AccountStatus resource, read using accountstatuses.get ) | Homepage.claimed (логическое поле output_only в ресурсе Homepage ) | Indicates if the uri is claimed and verified. This status is directly available in the Homepage resource returned by all its associated Merchant API methods. |
| Н/Д | UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage request body parameter) | Необязательная маска поля для homepage.update , указывающая, какие поля (например, uri ) ресурса Homepage обновляются. |