API для продавцов представляет собой специальный ресурс Homepage . Этот ресурс предоставляет новые методы для управления вашей заявкой на главную страницу, предлагая возможности, выходящие за рамки классического Content API для покупок.
Доступ к функциям вашего интернет-магазина состоит из двух этапов: сначала подтверждение права собственности, затем регистрация сайта в вашей учетной записи. Для завершения заключительного этапа используйте accounts.homepage.claim .
Ключевые отличия
API для продавцов вносит ряд изменений, касающихся главной страницы, по сравнению с Content API для магазинов:
- Выделенный ресурс : API для продавцов предоставляет отдельный ресурс
Homepage(accounts.homepage) для всех операций, связанных с главной страницей. (В Content API для покупок для выполнения действия по подтверждению права собственности использовалсяaccounts.claimwebsite, URL главной страницы (website_url) был частью ресурсаAccount», а статус подтверждения права собственности (website_claimed) — частью ресурсаAccountStatus.) - Детализированные методы : API для продавцов предлагает специальные методы для:
- Получить сведения о главной странице:
accounts.homepage.getHomepage - Обновите 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. - Перезапись заявки : Оба API поддерживают параметр
overwriteв процессе получения заявки, позволяющий перехватить заявку от другой учетной записи, если право собственности может быть подтверждено.
Запросы
API для продавцов использует отдельные RESTful-конечные точки для управления различными аспектами главной страницы.
| Описание запроса | 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 (действие выполнено на Account.website_url , установленном с помощью accounts.update ) | POST /accounts/v1/accounts/{account}/homepage:claim |
| Отказ от ответственности на главной странице | accounts.update (установка Account.website_url в пустую строку) | POST /accounts/v1/accounts/{account}/homepage:unclaim |
Идентификаторы
В API для продавцов упрощена процедура идентификации ресурсов.
| Описание идентификатора | API контента для покупок | API для продавцов |
|---|---|---|
| Идентификатор учетной записи для доступа к ресурсам | merchantId (расширенный аккаунт) и accountId (суб-аккаунт) в пути | account (часть поля name , например, accounts/{account_id}/homepage ) |
| Идентификатор ресурса главной страницы | Неприменимо (неявно относится к ресурсу Account ») | name : accounts/{account_id}/homepage (идентифицирует подресурс Homepage ») |
Методы
Метод 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 (для чтения Account.website_url ), accountstatuses.get (для чтения AccountStatus.website_claimed ) | accounts.homepage.getHomepage | Новый специализированный метод для получения текущего uri главной страницы и ее статуса claimed за один вызов. |
accounts.update (для установки Account.website_url ) | accounts.homepage.updateHomepage | Новый специальный метод для установки или изменения uri главной страницы. |
accounts.update (в качестве обходного пути для отмены авторизации установка Account.website_url в пустую строку) | accounts.homepage.unclaim | Новый специальный метод для явного снятия прав на домашнюю страницу. |
Подробные изменения полей
Способ структурирования и доступа к информации на главной странице значительно изменился, сместившись в сторону явного указания ресурса Homepage в API продавца.
| API контента для покупок | API для продавцов | Описание |
|---|---|---|
merchantId (параметр пути для accounts.claimwebsite ) | name (параметр пути для методов Homepage , формат: accounts/{account}/homepage ) | Часть name account записи в Merchant API соответствует accountId из Content API для покупок. |
accountId (параметр пути для accounts.claimwebsite ) | name (параметр пути для методов Homepage , формат: accounts/{account}/homepage ) | Идентификатор конкретной учетной записи, домашняя страница которой находится в процессе управления. |
overwrite (логическое значение в теле запроса ContentAccountsClaimwebsiteRequest и AccountsCustomBatchRequestEntry ) | ClaimHomepageRequest.overwrite (логическое значение в теле запроса homepage.claim ) | Необязательно. Если true , предпринимается попытка заявить права на веб-сайт, потенциально удаляя существующую заявку от другой учетной записи, если право собственности может быть подтверждено запрашивающей учетной записью. |
Account.website_url (поле в ресурсе Account , устанавливается с помощью accounts.update , считывается с помощью accounts.get ) | Homepage.uri (поле в ресурсе Homepage ) | URI (URL) главной страницы магазина. В Merchant API это явное поле в ресурсе Homepage . Оно устанавливается с помощью accounts.homepage.updateHomepage и возвращается всеми методами Homepage . |
AccountStatus.website_claimed (поле в ресурсе AccountStatus , считывается с помощью accountstatuses.get ) | Homepage.claimed (логическое поле output_only в ресурсе Homepage ) | Указывает, подтвержден ли и проверен ли uri . Этот статус доступен непосредственно в ресурсе Homepage , возвращаемом всеми связанными с ним методами Merchant API. |
| Н/Д | UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage (параметр тела запроса) | Необязательная маска поля для homepage.update , указывающая, какие поля (например, uri ) ресурса Homepage обновляются. |
API для продавцов представляет собой специальный ресурс Homepage . Этот ресурс предоставляет новые методы для управления вашей заявкой на главную страницу, предлагая возможности, выходящие за рамки классического Content API для покупок.
Доступ к функциям вашего интернет-магазина состоит из двух этапов: сначала подтверждение права собственности, затем регистрация сайта в вашей учетной записи. Для завершения заключительного этапа используйте accounts.homepage.claim .
Ключевые отличия
API для продавцов вносит ряд изменений, касающихся главной страницы, по сравнению с Content API для магазинов:
- Выделенный ресурс : API для продавцов предоставляет отдельный ресурс
Homepage(accounts.homepage) для всех операций, связанных с главной страницей. (В Content API для покупок для выполнения действия по подтверждению права собственности использовалсяaccounts.claimwebsite, URL главной страницы (website_url) был частью ресурсаAccount», а статус подтверждения права собственности (website_claimed) — частью ресурсаAccountStatus.) - Детализированные методы : API для продавцов предлагает специальные методы для:
- Получить сведения о главной странице:
accounts.homepage.getHomepage - Обновите 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. - Перезапись заявки : Оба API поддерживают параметр
overwriteв процессе получения заявки, позволяющий перехватить заявку от другой учетной записи, если право собственности может быть подтверждено.
Запросы
API для продавцов использует отдельные RESTful-конечные точки для управления различными аспектами главной страницы.
| Описание запроса | 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 (действие выполнено на Account.website_url , установленном с помощью accounts.update ) | POST /accounts/v1/accounts/{account}/homepage:claim |
| Отказ от ответственности на главной странице | accounts.update (установка Account.website_url в пустую строку) | POST /accounts/v1/accounts/{account}/homepage:unclaim |
Идентификаторы
В API для продавцов упрощена процедура идентификации ресурсов.
| Описание идентификатора | API контента для покупок | API для продавцов |
|---|---|---|
| Идентификатор учетной записи для доступа к ресурсам | merchantId (расширенный аккаунт) и accountId (суб-аккаунт) в пути | account (часть поля name , например, accounts/{account_id}/homepage ) |
| Идентификатор ресурса главной страницы | Неприменимо (неявно относится к ресурсу Account ») | name : accounts/{account_id}/homepage (идентифицирует подресурс Homepage ») |
Методы
Метод 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 (для чтения Account.website_url ), accountstatuses.get (для чтения AccountStatus.website_claimed ) | accounts.homepage.getHomepage | Новый специализированный метод для получения текущего uri главной страницы и ее статуса claimed за один вызов. |
accounts.update (для установки Account.website_url ) | accounts.homepage.updateHomepage | Новый специальный метод для установки или изменения uri главной страницы. |
accounts.update (в качестве обходного пути для отмены авторизации установка Account.website_url в пустую строку) | accounts.homepage.unclaim | Новый специальный метод для явного снятия прав на домашнюю страницу. |
Подробные изменения полей
The way homepage information is structured and accessed has changed significantly, moving towards the explicit Homepage resource in Merchant API.
| API контента для покупок | API для продавцов | Описание |
|---|---|---|
merchantId (параметр пути для accounts.claimwebsite ) | name (параметр пути для методов Homepage , формат: accounts/{account}/homepage ) | Часть name account записи в Merchant API соответствует accountId из Content API для покупок. |
accountId (параметр пути для accounts.claimwebsite ) | name (параметр пути для методов Homepage , формат: accounts/{account}/homepage ) | Идентификатор конкретной учетной записи, домашняя страница которой находится в процессе управления. |
overwrite (логическое значение в теле запроса ContentAccountsClaimwebsiteRequest и AccountsCustomBatchRequestEntry ) | ClaimHomepageRequest.overwrite (логическое значение в теле запроса homepage.claim ) | Необязательно. Если true , предпринимается попытка заявить права на веб-сайт, потенциально удаляя существующую заявку от другой учетной записи, если право собственности может быть подтверждено запрашивающей учетной записью. |
Account.website_url (поле в ресурсе Account , устанавливается с помощью accounts.update , считывается с помощью accounts.get ) | Homepage.uri (поле в ресурсе Homepage ) | URI (URL) главной страницы магазина. В Merchant API это явное поле в ресурсе Homepage . Оно устанавливается с помощью accounts.homepage.updateHomepage и возвращается всеми методами Homepage . |
AccountStatus.website_claimed (поле в ресурсе AccountStatus , считывается с помощью accountstatuses.get ) | Homepage.claimed (логическое поле output_only в ресурсе Homepage ) | Указывает, подтвержден ли и проверен ли uri . Этот статус доступен непосредственно в ресурсе Homepage , возвращаемом всеми связанными с ним методами Merchant API. |
| Н/Д | UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage (параметр тела запроса) | Необязательная маска поля для homepage.update , указывающая, какие поля (например, uri ) ресурса Homepage обновляются. |