Перенести настройки домашней страницы

API Merchant представляет специальный ресурс Homepage . Этот ресурс предоставляет новые методы управления заявками на главную страницу, предлагая возможности, выходящие за рамки классического API контента для покупок.

Доступ к функциям вашего интернет-магазина осуществляется в два этапа: сначала необходимо подтвердить право собственности, а затем заявить права на сайт для своей учётной записи. Для завершения последнего шага используйте метод accounts.homepage.claim .

Ключевые отличия

API продавца вносит несколько изменений, связанных с домашней страницей, по сравнению с API контента для покупок:

  • Выделенный ресурс : API торговца предоставляет отдельный ресурс Homepage ( accounts.homepage ) для всех операций, связанных с домашней страницей. (В Content API for Shopping вы использовали accounts.claimwebsite для выполнения действия по претензии, URL-адрес домашней страницы ( website_url ) был частью ресурса Account , а статус претензии ( website_claimed ) был частью ресурса AccountStatus .)
  • Детализированные методы : API торговца предлагает специальные методы для:
    • Получить данные домашней страницы: accounts.homepage.getHomepage
    • Обновите URI домашней страницы: accounts.homepage.updateHomepage
    • Заявите права на домашнюю страницу: accounts.homepage.claim
    • Отказаться от домашней страницы: accounts.homepage.unclaim API контента для покупок использует accounts.claimwebsite для действия по претензии, accounts.update для установки URL-адреса (и эффективного отказа путем установки пустого URL-адреса) и accounts.get / accountstatuses.get для получения URL-адреса и статуса претензии соответственно.
  • Централизованная информация : ресурс API продавца « Homepage содержит как uri (URL домашней страницы), так и claimed статус. Все методы, работающие с ресурсом Homepage , возвращают этот ресурс, предоставляя немедленную информацию о текущем состоянии. В API контента для покупок accounts.claimwebsite не возвращал обновлённый статус; требовались отдельные вызовы.
  • Явный отказ от ответственности : в Content API for Shopping отказ от ответственности обычно достигался путём замены Account.website_url на пустую строку. API Merchant предоставляет специальный метод 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 (настройка 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

Идентификаторы

Идентификация ресурсов в Merchant 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 Новый специальный метод для явного отзыва домашней страницы.

Подробные изменения полей

Существенно изменился способ структурирования и доступа к информации на домашней странице: в API Merchant появился явный ресурс Homepage .

API контента для покупок API торговца Описание
merchantId (параметр пути для accounts.claimwebsite ) name (параметр пути для методов Homepage , формат: accounts/{account}/homepage ) Часть строки name , относящаяся к account , в API продавца соответствует идентификатору accountId из 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 , возвращаемом всеми связанными с ним методами API продавца.
Н/Д UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage параметр тела запроса) Необязательная маска поля для homepage.update , указывающая, какие поля (например, uri ) ресурса Homepage обновляются.
Назад
Migrate user and access management
Далее
Migrate region management