О программе
Янтерем (Yanterem) создан для динамического генерирования, обработки и последующего сохранения отчетов на основе информации о распространении объявлений контекстной рекламы в сети "Интернет" на ресурсах Яндекс и на сайтах-партнерах его рекламной сети, созданных в Яндекс Директ. Программа может использоваться как коробочное решение или как встроенный модуль в сложные серверные корпоративные решения для распространение рекламы в сети "Интернет". Сценарии использования: ПК и серверные системы (включая контейнерные) для сбора и обработки больших объемов информации.

1. Роли в программе.
Программа представляет только одну роль - «Пользователь».

2. Требования к пользователю программы
Для эксплуатации программы Янтерем (Yanterem) предъявляются следующие требования к опыту и квалификации пользователя: - опыт работы с персональными компьютерами на операционных системах Linux (включая Astra Linux) и Unix, (включая MacOS)
- Опыт использования командной строки в указанных операционных системах.
- Опыт использования удаленных облачных сервисов (при использовании сценария для установки программы на удаленный сервер и для сохранения в объектное хранилище данных с поддержкой S3 API).

3. Пользовательский функционал программы Янтерем (Yanterem).
- Создание отчетов из 70 показателей за произвольный период.
- Автоматическая обработка информации из нескольких рекламных кабинетов, доступных пользователю.
- Возможность сохранения отчета в формате tsv как на компьютер пользователя, так и в объектное хранилище данных с поддержкой S3 API, например Яндекс Object Storage, ВК Cloud Storage.

4. Использование программы на операционных системах Linux и Unix Linux и Unix:
4.1. Сценарий сохранения отчета из рекламных кабинетов Яндекс.Директ в объектное хранилище данных с поддержкой S3 API . Команда yanterem save-remote с обязательными параметрами:
4.1.1. - S, --date-from <DATE_from>
необходима для выбора даты начала отчета.
4.1.2. -E, --date-to <DATE_TO>
необходима для выбора даты окончания отчета
4.1.3 -F, --report-fields <REPORT_FIELDS>
необходима для ввода полей, разделенных запятой. Список полей возможных для сохранения можно посмотреть на https://yandex.com/dev/direct/doc/reports/fields-list.html
4.1.4. -Y, --ya-direct-token <YA_DIRECT_TOKEN>
необходима для ввода API токена рекламного кабинета Яндекс.Директ, отчет из которого необходим пользователю.
Подробнее об использовании API токена указано на ресурсах Яндекса. https://yandex.ru/dev/direct/. https://yandex.ru/legal/direct_api/11022015/ https://yandex.ru/support/direct/alternative-interfaces/api.html
4.1.5. -L, --license-token <LICENSE_TOKEN>
необходима для ввода пользовательского ключа лицензии Янтерем (Yanterem).
4.1.6 . --s3-access-key <S3_ACCESS_KEY>
необходима для ввода ключа доступа к объектному хранилищу пользователя.
4.1.7. --s3-secret-key <S3_SECRET_KEY>
необходима для ввода секретного ключа доступа к объектному хранилищу пользователя.
4.1.8. --s3-region <S3_REGION>
необходима для ввода Области хранилища пользователя.
4.1.9. --s3-endopoint <S3_ENDOPOINT>
необходима для ввода конечной точки объектного хранилища пользователя.
4.1.10. --s3-bucket-name <S3_BUCKET_NAME>
необходима для ввода имени сегмента объектного хранилища пользователя.
4.1.11. --s3-path <S3_PATH>
необходима для ввода пути объектного хранилища, где хранить отчет.

4.1.12. Пример команды по сценарию сохранения отчета из рекламных кабинетов Яндекс.Директ в объектное хранилище данных с поддержкой S3 API с необходимыми параметрами:
./yanterem save-remote --date-from 2023-01-24 --date-to 2023-01-24 -F ClientLogin,Date,Cost --license-token XXXXX --s3-access-key XXXXX-G --s3-secret-key XXXXX --s3-region XXXXX --s3-endopoint https://storage.XXXXX.net --s3-bucket-name XXXXX --s3-path XXXXX --XXXXXX

4.2. Сценарий для сохранения отчета на локальный компьютер пользователя. Команда yanterem save-local с обязательными параметрами:
4.2.1. - S, --date-from <DATE_from> необходима для выбора даты начала отчета.
Формат даты по примеру: 2023-01-30, год-месец-день.
4.2.2. -E, --date-to <DATE_TO> необходима для выбора даты окончания отчета. 2023-01-30, год-месец-день
4.2.3. -F, --report-fields <REPORT_FIELDS> необходима для ввода полей, разделенных запятой. Список полей возможных для сохранения можно посмотреть на https://yandex.com/dev/direct/doc/reports/fields-list.html.
Пример ввода полей: ClientLogin,Date,Cost
4.2.4. -Y, --ya-direct-token <YA_DIRECT_TOKEN> необходима для ввода API токена рекламного кабинета Яндекс.Директ, отчет из которого необходим пользователю. Подробнее об использовании API токена указано на ресурсах Яндекса. https://yandex.ru/dev/direct/. https://yandex.ru/legal/direct_api/11022015/ https://yandex.ru/support/direct/alternative-interfaces/api.html
4.2.5. -L, --license-token <LICENSE_TOKEN> необходима для ввода пользовательского ключа лицензии Янтерем (Yanterem).
4.2.6. --report-name <REPORT_NAME> необходима для ввода имени файла пользователя для сохранения в него отчета.

4.2.7. Пример команды по сценарию сохранения отчета на локальный компьютер пользователя:
./yanterem save-local --XXXXX --date-to XXXXX -F ClientLogin,Date,Cost --license-tokenXXXXX-Y -Y XXXXX --report-name XXXXX

4.3. Команда вывода помощи
-h, --help
Команда выводит пользователю раздел помощи по программе Янтерем (Yanterem).

4.4. Команда вывода версии.
-V, --version
Команда выводит пользователю установленную версию программы Янтерем (Yanterem).

В случае возникновения сложностей с использованиям программы свяжитесь с нашей службой поддержки используя электронную почту yanterem@зифириум.рф или оставьте заявку на консультацию по работе по телефону +79632494675.