OzonFromGAS 📖

Реализация методов Ozon Seller Api в среде Google Apps Script

Версия: 1.1.0 -- Полный справочник изменений в CHANGELOG.md

Идентификатор библиотеки: 1jNkKwjF2fasD2kSn9KvjtcOe-09LepeUS4016TolPomer8oo4bsFkPLt

Описание 📝

Проект начат в рамках подготовки материала для информационной платформы dev.ozon.ru.

Библиотека представляет из себя клиент для отправки запросов, адаптированный под выполнение в среде Google Apps Script. Все методы и типы в ней полностью соответствуют официальной документации, типы сгенерированы автоматически.

Для того, чтобы поставить галочку за соблюдение принципа разделения ответственности и облегчить поддержку -- в этой библиотеке только то, что есть в официальной документации. Различные функции-помощники, синтаксический сахар и вообще всё, что не касается методов Ozon Seller API, находится в таблице-примере.

Требования

• Google Apps Script (встроённая среда выполнения)
• TypeScript для разработки (компилируется в JavaScript)
• Ключи доступа к Ozon Seller API (можно получить в личном кабинете продавца)

Поддерживаемые эндпоинты

Библиотека покрывает методы Ozon Seller API, включая:

• /v3/product/list -- получение списка товаров
• /v2/products/stocks -- получение информации об остатках
• /v5/product/info/prices -- получение информации о ценах
• Полный список поддерживаемых методов смотрите в исходном коде или в документации Ozon Seller API

Быстрый старт 🚀

Подключение библиотеки к скрипту

1. В редакторе скриптов нажимаем на иконку “+” рядом с пунктом “библиотеки”
2. В появившемся окне в поле “Идентификатор скрипта” вводим идентификатор библиотеки 1jNkKwjF2fasD2kSn9KvjtcOe-09LepeUS4016TolPomer8oo4bsFkPLt и нажимаем кнопку “найти”
   
3. Если идентификатор библиотеки введен верно, то увидим следующее окно. Выбираем самую последнюю версию (она необязательно будет 1)
   
4. После подключения к скрипту, в разделе “Библиотеки” появится новый, нужный нам элемент. Значение “OzonApi” говорит о том, что именно через этот объект возможно получить доступ.
   Например, так: const client = OzonApi.client(keys);
   

Скрипты и команды

Обновление типов API из Swagger:

npm run updateApi

Эта команда загружает официальную Swagger-схему Ozon API и генерирует актуальные TypeScript-типы в директорию ozon_api/.

Примеры использования

1.Получение списка идентификатор товара

    /** Инициализируем апи клиент */
    const client = OzonApi.client(keys);
    const productsIdsListResponse = client.productApiGetProductList({
        filter: {
            /*  Можно отфильтровать по offer_id, чтобы получить другие данные о товаре */
            // offer_id: [''],
            /* или по product_id */
            // product_id: [''],
            /** Здесь фильтр "по видимости", подробнее - https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductList */
            visibility: 'ALL',
        },
        limit: 20,
    });

2. Получение данных о товарах по списку идентификаторов

    /** Инициализируем апи клиент */
    const client = OzonApi.client(keys);
    
    /**Запрашиваем информацию о товарах по полученному списку offer_id */
    const productsInfoListResponse = client.productApiGetProductInfoListV2({
        offer_id: productsOfferIds,
    });

Смотри подробности в таблице

Авторы

• @Дмитрий
• @Александр

Поддержка и сообщество

• Чат в Telegram -- ответы на вопросы и помощь
• Канал в Telegram -- статьи про Гугл Таблицы, скрипты и автоматизацию