Переход с accountstatuses на Aggregate Product Statuses

Изменился способ получения сводной статистики по товарам и проблемам. Функции, которые ранее были доступны в ресурсе accountstatuses в Content API for Shopping, теперь разделены между отдельными ресурсами в Merchant API. В этом руководстве рассказывается, как перейти на использование нового ресурса aggregateProductStatuses.

Основные различия

Вот основные различия между функциями статуса товара в Content API for Shopping и Merchant API:

  • Специальные ресурсы. Ресурс accountstatuses из Content API for Shopping теперь разделен. В Merchant API проблемы на уровне аккаунта доступны через ресурс accountissues, а агрегированная статистика по товарам и проблемы на уровне товаров – через новый ресурс aggregateProductStatuses.
  • Новая структура ресурсов. AggregateProductStatus – это новый ресурс, который содержит статистику и информацию о проблемах для определенного сочетания контекста отчета и страны.
  • Механизм фильтрации. Вместо параметров запроса, таких как destinations, для выбора данных в Merchant API используется метод list со строкой filter, позволяющий запрашивать определенные контексты отчетов и страны.
  • Удаление поля Channel. Поле channel больше не используется. Теперь эта информация неявно входит в reportingContext.

Запросы

Merchant API использует запрос GET с параметром filter для получения агрегированных статусов товаров. Подробную информацию о синтаксисе фильтров можно найти в разделе Синтаксис фильтров.

GET https://merchantapi.googleapis.com/issueresolution/v1/{parent=accounts/*}/aggregateProductStatuses

Формат URL запроса

Описание запроса Content API for Shopping Merchant API
Как получить статистику по товарам и узнать о проблемах с ними GET /content/v2.1/{merchantId}/accountstatuses/{accountId} GET /issueresolution/v1/accounts/{accountId}/aggregateProductStatuses

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

В связи с новой структурой изменился способ идентификации ресурсов.

Формат идентификатора

Описание идентификатора Content API for Shopping Merchant API
Идентификатор ресурса Ресурс был идентифицирован по accountId. Определенные срезы данных были выбраны с помощью параметров запроса. Название ресурса уникально идентифицирует данные для определенного контекста отчета и страны: accounts/{account}/aggregateProductStatuses/{reportingContext}~{country}.

Методы

Метод получения статусов товаров был обновлен до метода list, который поддерживает фильтрацию.

Метод Content API for Shopping Метод Merchant API Доступность и примечания
accountstatuses.get aggregateProductStatuses.list Метод accountstatuses.get возвращал один ресурс, содержащий всю статистику по товарам. Новый метод aggregateProductStatuses.list возвращает список ресурсов, по одному для каждого сочетания контекста отчета и страны. Чтобы получить определенные данные, используйте параметр filter. Для проблем на уровне аккаунта используйте accountissues.list.

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

Поля со статистикой и проблемами товаров были обновлены и реструктурированы в новом ресурсе AggregateProductStatus.

Content API for Shopping Merchant API Описание
products aggregate_product_statuses Массив products заменен повторяющимся полем aggregate_product_statuses в ответе списка.
destination reporting_context Поле destination заменено полем reporting_context, которое указывает контекст программы для статистики.
channel (нет эквивалентного поля) Поле channel удалено. Эта информация теперь входит в reporting_context.
statistics stats Объект statistics переименован в stats. Названия полей в них преобразуются в змеиный регистр, например activeCount заменяется на active_count.
itemLevelIssues.servability item_level_issues.severity Перечисление servability заменено на severity, которое описывает влияние проблемы.
itemLevelIssues.attributeName item_level_issues.attribute Поле attributeName переименовано в attribute.
itemLevelIssues.documentation item_level_issues.documentation_uri Поле documentation переименовано в documentation_uri.
itemLevelIssues.numItems item_level_issues.product_count Поле numItems переименовано в product_count.