AppMetrica Logs API
AppMetrica Logs API отдаёт сырые строки, из которых собираются отчёты: одну установку или одно событие e-commerce в строке, вместе с идентификаторами устройства и метками времени.
Аутентификация
Renta использует OAuth для аутентификации в Яндексе. Вы будете перенаправлены на страницу Яндекса, чтобы предоставить Renta ограниченный доступ к приложениям в AppMetrica.
Подключение источника AppMetrica Logs API
- Откройте раздел Connections > Catalog в левом меню.
- Откройте категорию Analytics и нажмите карточку AppMetrica Logs API.
Нажмите Log in to your Appmetrica Logs API account. Вы будете перенаправлены на страницу Яндекса для предоставления доступа.
Яндекс покажет экран входа со списком разрешений, которые запрашивает Renta, включая доступ к статистике ваших приложений в AppMetrica. Выберите аккаунт, у которого есть доступ к нужным приложениям, и подтвердите. После этого вы вернётесь в Renta.
Завершите настройку:
- Source name.
Укажите имя источника данных. Оно используется только в интерфейсе Renta. - Access granted.
Убедитесь, что аккаунт подключён успешно.
Нажмите Save, чтобы завершить.
Новый источник появится в списке Sources со статусом Active. Теперь его можно использовать в пайплайнах.
Создание пайплайна AppMetrica Logs API
Свяжите источник AppMetrica Logs API с назначением и настройте пайплайн.
В левом меню нажмите New pipeline. На шаге Source выберите AppMetrica Logs API в блоке Already connected и нажмите Next step.
Выберите созданное ранее подключение AppMetrica Logs API и нажмите Next step.
На шаге Destination выберите назначение (например, Google BigQuery) и нажмите Next step.
Выберите подключение назначения, куда нужно загружать данные, и нажмите Next step.
Настройка пайплайна
На последнем шаге выберите, какие данные AppMetrica выгружать и как Renta будет их загружать.
Настройка отчёта
Укажите приложение и выберите тип отчёта.
-
Counters Выберите приложение, из которого выгружаются данные. В списке перечислены приложения, доступные подключённому аккаунту Яндекса, по их названиям. Один пайплайн выгружает одно приложение.
-
Report Types Выберите, что выгружать. Один пайплайн выгружает один тип отчёта.
Тип отчёта Что содержит одна строка Installation report (установки) Одну установку: метки времени установки и клика, блок атрибуции (трекер, кампания, площадка, тип сопоставления, признаки реатрибуции и переустановки), идентификаторы устройства и атрибуты устройства, сети, географии и приложения. E-commerce report (события e-commerce) Одно событие e-commerce: его тип и атрибуты экрана, товара, корзины, заказа и источника перехода, вместе с идентификацией события, идентификаторами устройства и атрибутами устройства, сети, географии и приложения.
Параметры
Выберите поля, которые попадут в таблицу назначения. Схема набора данных определяется выбранными здесь параметрами.
| Название | Имя в API | Описание |
|---|---|---|
ecom_type text | ecom_type | Purchase event type. Possible values: show_screen, show_product_card, show_product_details, add_cart_item, remove_cart_item, begin_checkout, purchase. |
ecom_screen_name text | ecom_screen_name | Screen name. |
ecom_screen_search_query text | ecom_screen_search_query | Search query. |
ecom_screen_category_path_1 text | ecom_screen_category_path_1 | Screen category. Level 1. |
ecom_screen_category_path_2 text | ecom_screen_category_path_2 | Screen category. Level 2. |
ecom_screen_category_path_3 text | ecom_screen_category_path_3 | Screen category. Level 3. |
ecom_screen_category_path_4 text | ecom_screen_category_path_4 | Screen category. Level 4. |
ecom_screen_category_path_5 text | ecom_screen_category_path_5 | Screen category. Level 5. |
ecom_screen_category_path_6 text | ecom_screen_category_path_6 | Screen category. Level 6. |
ecom_screen_category_path_7 text | ecom_screen_category_path_7 | Screen category. Level 7. |
ecom_screen_category_path_8 text | ecom_screen_category_path_8 | Screen category. Level 8. |
ecom_screen_category_path_9 text | ecom_screen_category_path_9 | Screen category. Level 9. |
ecom_screen_category_path_10 text | ecom_screen_category_path_10 | Screen category. Level 10. |
ecom_product_name text | ecom_product_name | Product name. |
ecom_product_sku text | ecom_product_sku | Product ID. |
ecom_product_promocodes array_string | ecom_product_promocodes | Product promo codes. JSON array of strings. |
ecom_product_category_path_1 text | ecom_product_category_path_1 | Product category. Level 1. |
ecom_product_category_path_2 text | ecom_product_category_path_2 | Product category. Level 2. |
ecom_product_category_path_3 text | ecom_product_category_path_3 | Product category. Level 3. |
ecom_product_category_path_4 text | ecom_product_category_path_4 | Product category. Level 4. |
ecom_product_category_path_5 text | ecom_product_category_path_5 | Product category. Level 5. |
ecom_product_category_path_6 text | ecom_product_category_path_6 | Product category. Level 6. |
ecom_product_category_path_7 text | ecom_product_category_path_7 | Product category. Level 7. |
ecom_product_category_path_8 text | ecom_product_category_path_8 | Product category. Level 8. |
ecom_product_category_path_9 text | ecom_product_category_path_9 | Product category. Level 9. |
ecom_product_category_path_10 text | ecom_product_category_path_10 | Product category. Level 10. |
ecom_product_actual_price_fiat_unit_type text | ecom_product_actual_price_fiat_unit_type | Currency of the actual product price. |
ecom_product_actual_price_fiat_value float | ecom_product_actual_price_fiat_value | Actual product price. |
ecom_product_original_price_fiat_unit_type text | ecom_product_original_price_fiat_unit_type | Currency of the base product price. |
ecom_product_original_price_fiat_value float | ecom_product_original_price_fiat_value | Base product price. |
ecom_cart_item_price_fiat_unit_type text | ecom_cart_item_price_fiat_unit_type | Price currency for the item in the cart. |
ecom_cart_item_price_fiat_value float | ecom_cart_item_price_fiat_value | Price of the item in the cart. |
ecom_cart_item_quantity int | ecom_cart_item_quantity | Number of items in the cart. |
ecom_referrer_type text | ecom_referrer_type | Traffic source type. |
ecom_referrer_id text | ecom_referrer_id | Traffic source ID. |
ecom_order_id text | ecom_order_id | Purchase ID. |
event_datetime datetime | event_datetime | Date and time of the event in yyyy-mm-dd hh:mm:ss format. |
event_name text | event_name | Name of the event (as passed to the SDK). |
event_receive_datetime datetime | event_receive_datetime | Date and time the event was received on the server side. |
event_receive_timestamp int | event_receive_timestamp | Time when the event was received on the server side in Unix time format. |
event_timestamp int | event_timestamp | Time of the event in Unix time format. |
session_id text | session_id | Session ID. |
installation_id text | installation_id | Installation ID. |
appmetrica_device_id text | appmetrica_device_id | A unique device identifier detected by the AppMetrica service. |
city text | city | The name of the city where the click was made (in English). |
connection_type text | connection_type | Type of connection. Possible values: wifi | cell | unknown. |
country_iso_code text | country_iso_code | ISO country code. |
device_ipv6 text | device_ipv6 | The IP address at the time of the event in IPv6 format. |
device_locale text | device_locale | The language on the device. |
device_manufacturer text | device_manufacturer | The device manufacturer detected by the AppMetrica service. |
device_model text | device_model | The device model detected by the AppMetrica service. |
device_type text | device_type | The device type detected by the AppMetrica service. Possible values: phone | tablet | unknown. |
google_aid text | google_aid | The device's Google AID. |
ios_ifa text | ios_ifa | The device's IFA. |
ios_ifv text | ios_ifv | IFV for the app. |
mcc text | mcc | Mobile country code. |
mnc text | mnc | Mobile network code. |
operator_name text | operator_name | Name of the mobile operator. |
original_device_model text | original_device_model | Factory model of the device. |
os_version text | os_version | The version of the operating system on the user's device. |
profile_id text | profile_id | User profile ID. |
windows_aid text | windows_aid | The device's Windows AID. |
app_build_number text | app_build_number | App build number. |
app_package_name text | app_package_name | The package name for Android, or the Bundle ID for iOS. |
app_version_name text | app_version_name | The app version in the format specified by the developer. |
Today date | date_today | Today's date |
Year text | year | Year of the date |
Year of week (Sun-Sat) text | yearofweek | Year of week for US weeks |
Year of week (Mon-Sun) text | yearofweekiso | Year of week for ISO weeks |
Year & month text | yearmonth | Year and month combined |
Quarter text | quarter | Quarter of the year |
Month text | month | Month of the year |
Year & week (Sun-Sat) text | yearweek | Year and week for US weeks |
Year & week (Mon-Sun) text | yearweekiso | Year and week for ISO weeks |
Week (Sun-Sat) text | week | US week number |
Week (Mon-Sun) text | weekiso | ISO week number |
Day of week (Sun-Sat) text | dayOfWeekName | Day of week name for US weeks |
Day of week text | dayOfWeekNameIso | Day of week name for ISO weeks (Mon-Sun) |
Day of month text | dayOfMonth | Day of the month |
Date date | date | Specific date |
| Название | Имя в API | Описание |
|---|---|---|
application_id int | application_id | Unique numerical identifier of the application in AppMetrica. |
installation_id text | installation_id | Installation identifier. |
attributed_touch_type text | attributed_touch_type | Type of advertising interaction. Possible values: click, impression, unknown. |
click_datetime datetime | click_datetime | Date and time of the click/impression in the format yyyy-mm-dd hh:mm:ss. |
click_id text | click_id | Identifier of the click/impression or an empty string if not available. |
click_ipv6 text | click_ipv6 | IP address at the time of the click/impression in IPv6 format (e.g., 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147). |
click_timestamp int | click_timestamp | Timestamp of the click/impression in UNIX-time in seconds. |
click_url_parameters text | click_url_parameters | Parameters as represented in the link. Special characters should be escaped (e.g., ?param1%3D1%26param2%3D2...). |
click_user_agent text | click_user_agent | User-agent of the click/impression. |
profile_id text | profile_id | Identifier of the user profile. |
publisher_id int | publisher_id | Partner ID in AppMetrica. It can be used to identify the partner in AppMetrica reports. |
publisher_name text | publisher_name | Name of the AppMetrica partner. If unattributed postbacks are enabled for the tracker, the value will be empty. |
tracker_name text | tracker_name | Name of the tracker added in the AppMetrica interface. If unattributed postbacks are enabled, the value will be empty. |
tracking_id int | tracking_id | Tracker ID in AppMetrica. It can be used to identify the partner in reports. If unattributed postbacks are enabled, the value will be 0. |
install_datetime datetime | install_datetime | Date and time of installation in the format yyyy-mm-dd hh:mm:ss. |
install_ipv6 text | install_ipv6 | IP address at the time of installation in IPv6 format (e.g., 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147). |
install_receive_datetime datetime | install_receive_datetime | Date and time when the server received the installation event. May differ from install_datetime due to network delays or the user's offline status. |
install_receive_timestamp int | install_receive_timestamp | Server reception timestamp of the installation event in UNIX-time. |
install_timestamp int | install_timestamp | Timestamp of the installation in UNIX-time in seconds. |
is_reattribution bool | is_reattribution | Indicates reattribution of the installation to a new source. Possible values: true, false. |
is_reinstallation bool | is_reinstallation | Indicates whether the application was reinstalled. Possible values: true, false. |
match_type text | match_type | Attribution method: fingerprint, referrer, identifier, or an empty string. |
appmetrica_device_id int | appmetrica_device_id | Unique device identifier assigned by AppMetrica. |
city text | city | City name in English where the click occurred. |
connection_type text | connection_type | Device connection type. Possible values: wifi, cell, unknown. |
country_iso_code text | country_iso_code | ISO code of the country. |
device_locale text | device_locale | Device interface language. |
device_manufacturer text | device_manufacturer | Device manufacturer, determined by AppMetrica (e.g., Apple, Samsung). |
device_model text | device_model | Device model, determined by AppMetrica (e.g., Galaxy S6). |
device_type text | device_type | Device type determined by AppMetrica. Possible values: phone, tablet, unknown. |
google_aid text | google_aid | Google AID of the device as received from the device. |
oaid text | oaid | Huawei OAID of the device as received from the device. |
ios_ifa text | ios_ifa | IFA of the device as received from the device. |
ios_ifv text | ios_ifv | IFV for the application as received from the device. |
mcc int | mcc | Mobile country code. |
mnc int | mnc | Mobile network code. |
operator_name text | operator_name | Name of the mobile operator. |
os_name text | os_name | Operating system on the user's device: ios, android, windows. |
os_version text | os_version | Version of the operating system on the user's device. |
windows_aid text | windows_aid | Windows AID of the device as received from the device. |
app_package_name text | app_package_name | Package name for Android or Bundle ID for iOS (e.g., ru.yandex.metro). |
app_version_name text | app_version_name | Application version as specified by the developer. |
Today date | date_today | Today's date |
Year text | year | Year of the date |
Year of week (Sun-Sat) text | yearofweek | Year of week for US weeks |
Year of week (Mon-Sun) text | yearofweekiso | Year of week for ISO weeks |
Year & month text | yearmonth | Year and month combined |
Quarter text | quarter | Quarter of the year |
Month text | month | Month of the year |
Year & week (Sun-Sat) text | yearweek | Year and week for US weeks |
Year & week (Mon-Sun) text | yearweekiso | Year and week for ISO weeks |
Week (Sun-Sat) text | week | US week number |
Week (Mon-Sun) text | weekiso | ISO week number |
Day of week (Sun-Sat) text | dayOfWeekName | Day of week name for US weeks |
Day of week text | dayOfWeekNameIso | Day of week name for ISO weeks (Mon-Sun) |
Day of month text | dayOfMonth | Day of the month |
Date date | date | Specific date |
Список Parameters представляет собой один плоский перечень полей, доступных для выбранного типа отчёта, названных ровно так, как они называются в Logs API: installation_id, appmetrica_device_id, ecom_product_sku. Быстрее всего найти нужное поле через поиск. Select All отмечает весь перечень.
Выберите хо тя бы одно поле: пайплайн с пустым списком Parameters создать нельзя.
В списке отчёта Installation report есть атрибуция (tracker_name, publisher_name, click_datetime, attributed_touch_type, is_reattribution), метки времени установки, идентификаторы устройства (appmetrica_device_id, google_aid, ios_ifa, oaid), а также атрибуты устройства, сети, географии и приложения.
Список отчёта E-commerce report построен вокруг воронки: тип события в поле ecom_type, затем поля экрана, товара, корзины и заказа, плюс идентификация события (event_name, event_datetime, session_id) и те же атрибуты устройства и приложения.
В таблице назначения имена колонок повторяют имена полей Logs API как есть. В Google BigQuery Renta дополнительно переносит описание каждого поля в описание соответствующей колонки.
Параметры даты
В списке также есть поля дат, которые вычисляет Renta: Date и Today, а также календарные поля Year, Quarter, Month, Week, Day of week и другие. Renta выводит их из даты установки в отчёте Installation report и из даты события в отчёте E-commerce report.
Имя таблицы и диапазон дат
Задайте имя пайплайна и исторический период загрузки.
- Integration name.
Имя пайплайна. Используется только в интерфейсе Renta. - Table name.
Имя таблицы в назначении. Можно оставить сген ерированное имя или задать своё. - Date start.
Первая дата периода выгрузки. - Date end.
Последняя дата периода выгрузки. Установите значение Yesterday.
Overwrite period
Overwrite period задаёт, сколько последних дней Renta перезагружает при каждом запуске. Настройка появляется после того, как в разделе Parameters выбран параметр Date.
При каждом запуске Renta заново запрашивает данные начиная с даты последнего успешного запуска минус период перезаписи. Затронутые дни удаляются из таблицы назначения и вставляются заново, а более ранние данные остаются нетронутыми.
Расписание
Выберите, как часто запускается пайплайн.
| Тип расписания | Описание |
|---|---|
| Manual | Пайплайн запускается только вручную через интерфейс или по API. |
| Daily | Пайплайн запускается раз в сутки в указанное время обновления. |
| Interval | Пайплайн запускается через заданные интервалы времени. |
| Cron Expression | Пайплайн запускается по расписанию, заданному cron-выражением. |
Для расписания Daily укажите Update time (точное время запуска), затем нажмите Create pipeline.
Новый пайплайн появится в разделе Pipelines на вкладке ETL, где можно отслеживать запуски, прогресс и имя таблицы назначения.
Стратегия синхронизации
Стратегия синхронизации зависит от того, включён ли в отчёт параметр Date.
| Стратегия | Поддерживаемые типы отчётов | Описание |
|---|---|---|
| Инкрементальное обновление | Installation report, E-commerce report (с выбранным параметром Date или Today) | Каждая строка несёт свою дату, и таблица назначения партиционируется по колонке date. При каждом запуске Renta запрашивает окно от даты последнего успешного запуска минус период перезаписи до конца диапазон а дат: затронутые дневные партиции удаляются и вставляются заново, а более ранние партиции остаются нетронутыми. |
| Полная перезагрузка | Installation report, E-commerce report (без параметра даты) | В таблице нет колонки с датой, по которой можно партиционировать, поэтому Renta запрашивает весь заданный диапазон дат и заменяет набор данных при каждом запуске. |
Ready to get started?
Build your data pipeline today or get a personalized demo. Start free!
Need help?
Get expert support to ensure your project succeeds. We're here to help!
Feature requests?
Help shape our product! Share your ideas for new features and integrations.