Facebook Ads
Renta позволяет синхронизировать данные из вашего аккаунта Facebook Ads напрямую в хранилище данных, автоматизируя процесс переноса маркетинговых данных в ваш аналитический стек.
Аутентификация
Renta использует метод аутентификации OAuth для безопасного подключения вашего аккаунта Facebook Ads. Этот метод гарантирует, что ваши учетные данные не будут переданы Renta напрямую, предоставляя при этом необходимый ограниченный доступ.
Подключение источника Facebook Ads
Выполните следующие шаги, чтобы добавить Facebook Ads в качестве источника в Renta с помощью аутентификации OAuth.
Перейдите в каталогStep 1
Перейдите в раздел Connections > Catalog в левом боковом меню.
Выберите Facebook AdsStep 2
Найдите и выберите Facebook Ads в категории Advertising.
Авторизуйте подключениеStep 3
Нажмите кнопку Log in to your Facebook Ads account. Вы будете перенаправлены на Facebook для входа через OAuth.
Предоставьте доступStep 4
Ознакомьтесь с запрашиваемыми разрешениями для предоставления Renta доступа к вашему аккаунту и нажмите Reconnect (или Continue).
Настройте подключениеStep 5
Заполните данные подключения:
- Source name.
Укажите имя источника данных. Оно используется исключительно в интерфейсе Renta. - Нажмите Save, чтобы завершить настройку.
Ваш новый источник теперь появится в списке источников.
Настройки пайплайна
При создании пайплайна с источником Facebook Ads вам необходимо настроить следующие параметры:
Integration type
Выберите способ настройки выгрузки данных.
| Тип | Описание |
|---|---|
| Custom report | Вы сами выбираете параметры и метрики для выгрузки. Подходит, когда нужна своя структура отчёта, давая полный контроль над выбором данных. |
| Pre-built templates | Используются готовые шаблоны хранилищ (Data Mart models), где набор полей уже задан. Удобно для типовых сценариев с минимальными настройками. |
Ad accounts
Список доступных рекламных аккаунтов Facebook, подключённых через источник. Выбирается аккаунт (или несколько), из которого будут браться данные.
Report types
Ниже в таблице приведены доступные типы отчетов для синхронизации данных из Facebook Ads в ваше хранилище.
| Тип отчета | Описание |
|---|---|
| Statistics report | Статистика рекламного аккаунта по всем уровням (кампания, группа, объявление). Включает метрики (показы, клики, spend, reach и т.п.), breakdowns и кастомные конверсии. |
| Campaign metadata | Метаданные кампаний (статус, бюджеты, цели, даты создания). Это снимок состояния, без метрик производительности. |
| Ad group metadata | Метаданные групп объявлений (бюджеты, таргетинг, оптимизации, статусы и т.п.). Это снимок состояния. |
| Ad metadata | Метаданные объявлений (статусы, ID кампании/группы, креатив, ссылки и т.п.). Это снимок состояния. |
| Ad account metadata | Метаданные аккаунта (валюта, баланс, бизнес-информация, таймзона). Снимок настроек аккаунта, без статистики. |
Ad action report time
(Только для Statistics report). Определяет, когда считать конверсии и другие действия в отчетах.
| Значение | Описание |
|---|---|
| Mixed | Используется модель Facebook, сочетающая impression и click. |
| Impression | Конверсия учитывается по показу объявления. |
| Conversion | Конверсия учитывается по моменту совершения действия. |
| Lifetime | Учитываются все действия за всё время. |
Attribution settings
(Только для Statistics report). Определяет, какие настройки атрибуции использовать.
| Настройка | Описание |
|---|---|
| Use account attribution setting | Используются настройки атрибуции, заданные в вашем рекламном аккаунте Facebook. |
| Use unified attribution setting | Используется единая модель атрибуции Facebook. |
Параметры (Parameters)
В этом разделе вы можете указать метрики и измерения, которые Renta будет синхронизировать с вашим хранилищем данных.
| Название | Имя в API | Описание |
|---|---|---|
Account Currency text | account_currency | Currency that is used by your ad account. |
Account ID text | account_id | The ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing. |
Account Name text | account_name | The name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing. |
Ad ID text | ad_id | The unique ID of the ad you're viewing in reporting. |
Ad Name text | ad_name | The name of the ad you're viewing in reporting. |
Ad Set ID text | adset_id | The unique ID of the ad set you're viewing in reporting. An ad set is a group of ads that share the same budget, schedule, delivery optimization and targeting. |
Ad Set Name text | adset_name | The name of the ad set you're viewing in reporting. An ad set is a group of ads that share the same budget, schedule, delivery optimization and targeting. |
App ID text | app_id | The ID of the application associated with the Ad Account or Campaign requested. The application information, including its ID, is viewable in the App Dashboard. |
Attribution Setting text | attribution_setting | The default attribution window to be used when the attribution result is calculated. Each ad set has its own attribution setting value. |
Buying Type text | buying_type | The method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying. |
Campaign ID text | campaign_id | The unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads. |
Campaign Name text | campaign_name | The name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads. |
Canvas Average View Percent float | canvas_avg_view_percent | The average percentage of the Instant Experience that people saw. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. |
Canvas Average View Time float | canvas_avg_view_time | The average total time, in seconds, that people spent viewing an Instant Experience. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. |
Clicks int | clicks | The number of clicks on your ads. |
Unique clicks int | unique_clicks | The number of unique clicks on your ads. |
Coarse Conversion Value text | coarse_conversion | Allows advertisers and ad networks to receive directional post-install quality insights when the volume of campaign conversions isn't high enough to meet the privacy threshold needed to unlock the standard conversion value. |
Conversion Rate Ranking text | conversion_rate_ranking | A ranking of your ad's expected conversion rate. Your ad is ranked against ads with your optimization goal that competed for the same audience. |
Cost per Estimated Ad Recallers float | cost_per_estimated_ad_recallers | The average cost for each estimated ad recall lift. This metric is only available for assets in the Brand awareness, Post engagement and views Objectives. |
Cost per Inline Link Click float | cost_per_inline_link_click | The average cost of each inline link click. |
Cost per Inline Post Engagement float | cost_per_inline_post_engagement | The average cost of each inline post engagement. |
Cost per Unique Click float | cost_per_unique_click | The average cost for each unique click (all). This metric is estimated. |
Cost per Unique Inline Link Click float | cost_per_unique_inline_link_click | The average cost of each unique inline link click. This metric is estimated. |
CPC (Cost per Click) float | cpc | The average cost for each click (all). |
CPM (Cost per Mille) float | cpm | The average cost for 1,000 impressions. |
CPP (Cost per Person) float | cpp | The average cost to reach 1,000 people. This metric is estimated. |
CTR (Click-Through Rate) float | ctr | The percentage of times people saw your ad and performed a click (all). |
Unique CTR (Unique Click-Through Rate) float | unique_ctr | The percentage of times people saw your ad and performed a click (all). |
Date date | date | The start date for your data. This is controlled by the date range you've selected for your reporting view. |
Date start date | date_start | The start date for your data. This is controlled by the date range you've selected for your reporting view. |
Engagement Rate Ranking text | engagement_rate_ranking | A ranking of your ad's expected engagement rate. Your ad is ranked against ads that competed for the same audience. |
Estimated Ad Recall Rate float | estimated_ad_recall_rate | The rate at which an estimated number of additional people, when asked, would remember seeing your ads within 2 days. |
Estimated Ad Recallers int | estimated_ad_recallers | An estimate of the number of additional people who may remember seeing your ads, if asked, within 2 days. |
Fidelity Type text | fidelity_type | To differentiate StoreKit-rendered ads from view-through ads, SKAdNetwork defines a fidelity-type parameter. |
Full View Impressions int | full_view_impressions | The number of Full Views on your Page's posts as a result of your ad. |
Total action value (Deprecated) int | total_action_value | This parameter is no longer supported and always returns a value of 0. |
Lead CPA (Deprecated) int | lead_cpa | This parameter is no longer supported and always returns a value of 0. |
Frequency float | frequency | The average number of times each person saw your ad. |
Full View Reach int | full_view_reach | The number of people who performed a Full View on your Page's post as a result of your ad. |
HSID text | hsid | The hsid key is available for ad impressions that use SKAdNetwork 4 and later. |
Impressions int | impressions | The number of times your ads were on screen. |
Inline Link Click CTR float | inline_link_click_ctr | The percentage of time people saw your ads and performed an inline link click. |
Inline Link Clicks int | inline_link_clicks | The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties. |
Inline Post Engagement int | inline_post_engagement | The total number of actions that people take involving your ads. |
Instagram Upcoming Event Reminders Set int | instagram_upcoming_event_reminders_set | The number of reminders set on an upcoming event, taking into account reminders unset. |
Instant Experience Clicks to Open int | instant_experience_clicks_to_open | The number of clicks on your ad that open an Instant Experience. |
Instant Experience Clicks to Start int | instant_experience_clicks_to_start | The number of times an interactive component in an Instant Experience starts. |
Is Conversion ID Modeled int | is_conversion_id_modeled | A boolean flag that indicates whether the conversion_bits are modeled. |
Objective text | objective | The objective reflecting the goal you want to achieve with your advertising. |
Optimization Goal text | optimization_goal | The optimization goal you selected for your ad or ad set. |
Place Page Name text | place_page_name | The name of the place page involved in impression or click. |
Postback Sequence Index text | postback_sequence_index | Sequence of postbacks received from SkAdNetwork API version 4.0. |
Qualifying Question Qualify Answer Rate float | qualifying_question_qualify_answer_rate | The rate at which people provided a qualifying answer to a question. |
Quality Ranking text | quality_ranking | A ranking of your ad's perceived quality. Quality is measured using feedback on your ads and the post-click experience. |
Reach int | reach | The number of people who saw your ads at least once. Reach is different from impressions, which may include multiple views of your ads by the same people. |
Redownload bool | redownload | Boolean flag that indicates the customer redownloaded and reinstalled the app when the value is true. |
SKAN Campaign ID text | skan_campaign_id | The raw campaign ID received as a part of Skan postback from iOS 15+. |
SKAN Conversion ID text | skan_conversion_id | The assigned Conversion ID (also referred to as Priority ID) of the event and/or event bundle configured in the application’s SKAdNetwork configuration schema. |
Social Spend float | social_spend | The total amount you've spent so far for your ads showed with social information. |
Spend float | spend | The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. |
Total Postbacks int | total_postbacks | The total number of postbacks received from Apple’s SKAdNetwork API. |
User Segment Key text | user_segment_key | The user segment (e.g., new, existing) of Advantage+ Shopping Campaigns (ASC). |
UTM-medium text | utm_medium | Value of utm-medium extracted from ad url. |
UTM-source text | utm_source | Value of utm-source extracted from ad url. |
UTM-campaign text | utm_campaign | Value of utm-campaign extracted from ad url. |
UTM-content text | utm_content | Value of utm-content extracted from ad url. |
UTM-term text | utm_term | Value of utm-term extracted from ad url. |
Ad URL text | href | Extracted url of the ad with get parameters. |
Cost per Outbound Click float | cost_per_outbound_click | The average cost for each outbound click. |
Cost per Outbound Click (Inline) float | cost_per_outbound_click_inline | The average cost for each outbound click, calculated based on the selected attribution window. |
Cost per Unique Outbound Click float | cost_per_unique_outbound_click | The average cost for each unique outbound click. |
Cost per Unique Outbound Click (Inline) float | cost_per_unique_outbound_click_inline | The average cost for each unique outbound click, calculated based on the selected attribution window. |
Outbound Clicks int | outbound_clicks | The number of clicks on links that take people off Facebook-owned properties. |
Outbound Clicks (Inline) int | outbound_clicks_inline | The number of outbound clicks, calculated based on the selected attribution window. |
Outbound Clicks CTR float | outbound_clicks_ctr | The percentage of times people saw your ad and performed an outbound click. |
Outbound Clicks CTR (Inline) float | outbound_clicks_ctr_inline | The outbound click-through rate, calculated based on the selected attribution window. |
Unique Outbound Clicks int | unique_outbound_clicks | The number of unique outbound clicks. |
Unique Outbound Clicks (Inline) int | unique_outbound_clicks_inline | The number of unique outbound clicks, calculated based on the selected attribution window. |
Unique Outbound Clicks CTR float | unique_outbound_clicks_ctr | The percentage of times people saw your ad and performed a unique outbound click. |
Unique Outbound Clicks CTR (Inline) float | unique_outbound_clicks_ctr_inline | The unique outbound click-through rate, calculated based on the selected attribution window. |
Website CTR float | website_ctr | The percentage of times people saw your ad and performed a link click. |
Page Engagement int | page_engagement | The total number of actions that people take involving your Page as a result of your ad. |
Page Engagement (Inline) int | page_engagement_inline | The total number of actions involving your Page, calculated based on the selected attribution window. |
Post Engagement int | post_engagement | The total number of actions that people take involving your posts as a result of your ad. |
Post Engagement (Inline) int | post_engagement_inline | The total number of actions involving your posts, calculated based on the selected attribution window. |
All Leads int | lead | The total number of offsite leads and on-Facebook leads as a result of your ad. |
All Leads (Inline) int | lead_inline | The total number of leads, both offsite and on-Facebook, calculated based on the selected attribution window. |
On-Facebook Leads from Messenger and Instant Forms int | leadgen_grouped | The total number of on-Facebook leads coming from Messenger and Instant Forms as a result of your ad. |
On-Facebook Leads from Messenger and Instant Forms (Inline) int | leadgen_grouped_inline | The total number of on-Facebook leads from Messenger and Instant Forms, calculated based on the selected attribution window. |
All On-Facebook Leads int | onsite_conversion.lead_grouped | The total number of lead generation actions taken on Facebook as a result of your ad. |
All On-Facebook Leads (Inline) int | onsite_conversion.lead_grouped_inline | The total number of on-Facebook lead generation actions, calculated based on the selected attribution window. |
App Installs int | omni_app_install | The total number of app installs as a result of your ad. |
App Installs (Inline) int | omni_app_install_inline | The total number of app installs, calculated based on the selected attribution window. |
Purchases int | omni_purchase | The total number of purchases made as a result of your ad. |
Purchases (Inline) int | omni_purchase_inline | The total number of purchases, calculated based on the selected attribution window. |
Adds to Cart int | omni_add_to_cart | The total number of times items were added to cart as a result of your ad. |
Adds to Cart (Inline) int | omni_add_to_cart_inline | The total number of adds to cart, calculated based on the selected attribution window. |
Registrations Completed int | omni_complete_registration | The total number of completed registrations as a result of your ad. |
Registrations Completed (Inline) int | omni_complete_registration_inline | The total number of completed registrations, calculated based on the selected attribution window. |
Content Views int | omni_view_content | The total number of content views as a result of your ad. |
Content Views (Inline) int | omni_view_content_inline | The total number of content views, calculated based on the selected attribution window. |
Searches int | omni_search | The total number of searches performed as a result of your ad. |
Searches (Inline) int | omni_search_inline | The total number of searches, calculated based on the selected attribution window. |
Checkouts Initiated int | omni_initiated_checkout | The total number of checkouts initiated as a result of your ad. |
Checkouts Initiated (Inline) int | omni_initiated_checkout_inline | The total number of checkouts initiated, calculated based on the selected attribution window. |
Achievements Unlocked int | omni_achievement_unlocked | The total number of achievements unlocked as a result of your ad. |
Achievements Unlocked (Inline) int | omni_achievement_unlocked_inline | The total number of achievements unlocked, calculated based on the selected attribution window. |
App Activations int | omni_activate_app | The total number of app activations as a result of your ad. |
App Activations (Inline) int | omni_activate_app_inline | The total number of app activations, calculated based on the selected attribution window. |
Levels Achieved int | omni_level_achieved | The total number of levels achieved in an app as a result of your ad. |
Levels Achieved (Inline) int | omni_level_achieved_inline | The total number of levels achieved, calculated based on the selected attribution window. |
Ratings Submitted int | omni_rate | The total number of ratings submitted for an app as a result of your ad. |
Ratings Submitted (Inline) int | omni_rate_inline | The total number of ratings submitted, calculated based on the selected attribution window. |
Credit Spends int | omni_spend_credits | The total number of credits spent in an app as a result of your ad. |
Credit Spends (Inline) int | omni_spend_credits_inline | The total number of credits spent, calculated based on the selected attribution window. |
Tutorials Completed int | omni_tutorial_completion | The total number of tutorials completed in an app as a result of your ad. |
Tutorials Completed (Inline) int | omni_tutorial_completion_inline | The total number of tutorials completed, calculated based on the selected attribution window. |
Custom Events int | omni_custom | The total number of custom events triggered as a result of your ad. |
Custom Events (Inline) int | omni_custom_inline | The total number of custom events, calculated based on the selected attribution window. |
Mobile App Feature Unlocks int | app_custom_event.fb_mobile_achievement_unlocked | The total number of mobile app feature unlocks as a result of your ad. |
Mobile App Feature Unlocks (Inline) int | app_custom_event.fb_mobile_achievement_unlocked_inline | The total number of mobile app feature unlocks, calculated based on the selected attribution window. |
Mobile App Starts int | app_custom_event.fb_mobile_activate_app | The total number of mobile app starts as a result of your ad. |
Mobile App Starts (Inline) int | app_custom_event.fb_mobile_activate_app_inline | The total number of mobile app starts, calculated based on the selected attribution window. |
Mobile App Payment Details int | app_custom_event.fb_mobile_add_payment_info | The total number of times payment information was added in the mobile app as a result of your ad. |
Mobile App Payment Details (Inline) int | app_custom_event.fb_mobile_add_payment_info_inline | The total number of times payment information was added in the mobile app, calculated based on the selected attribution window. |
Mobile App Adds To Cart int | app_custom_event.fb_mobile_add_to_cart | The total number of times items were added to cart within the mobile app as a result of your ad. |
Mobile App Adds To Cart (Inline) int | app_custom_event.fb_mobile_add_to_cart_inline | The total number of times items were added to cart within the mobile app, calculated based on the selected attribution window. |
Mobile App Adds to Wishlist int | app_custom_event.fb_mobile_add_to_wishlist | The total number of times items were added to a wishlist within the mobile app as a result of your ad. |
Mobile App Adds to Wishlist (Inline) int | app_custom_event.fb_mobile_add_to_wishlist_inline | The total number of times items were added to a wishlist within the mobile app, calculated based on the selected attribution window. |
Mobile App Registrations int | app_custom_event.fb_mobile_complete_registration | The total number of completed registrations within the mobile app as a result of your ad. |
Mobile App Registrations (Inline) int | app_custom_event.fb_mobile_complete_registration_inline | The total number of completed registrations within the mobile app, calculated based on the selected attribution window. |
Mobile App Content Views int | app_custom_event.fb_mobile_content_view | The total number of content views within the mobile app as a result of your ad. |
Mobile App Content Views (Inline) int | app_custom_event.fb_mobile_content_view_inline | The total number of content views within the mobile app, calculated based on the selected attribution window. |
Mobile App Checkouts int | app_custom_event.fb_mobile_initiated_checkout | The total number of checkouts initiated within the mobile app as a result of your ad. |
Mobile App Checkouts (Inline) int | app_custom_event.fb_mobile_initiated_checkout_inline | The total number of checkouts initiated within the mobile app, calculated based on the selected attribution window. |
Mobile App Achievements int | app_custom_event.fb_mobile_level_achieved | The total number of achievements reached within the mobile app as a result of your ad. |
Mobile App Achievements (Inline) int | app_custom_event.fb_mobile_level_achieved_inline | The total number of achievements reached within the mobile app, calculated based on the selected attribution window. |
Mobile App Purchases int | app_custom_event.fb_mobile_purchase | The total number of purchases made within the mobile app as a result of your ad. |
Mobile App Purchases (Inline) int | app_custom_event.fb_mobile_purchase_inline | The total number of purchases made within the mobile app, calculated based on the selected attribution window. |
Mobile App Ratings int | app_custom_event.fb_mobile_rate | The total number of ratings submitted for the mobile app as a result of your ad. |
Mobile App Ratings (Inline) int | app_custom_event.fb_mobile_rate_inline | The total number of mobile app ratings, calculated based on the selected attribution window. |
Mobile App Searches int | app_custom_event.fb_mobile_search | The total number of searches performed within the mobile app as a result of your ad. |
Mobile App Searches (Inline) int | app_custom_event.fb_mobile_search_inline | The total number of mobile app searches, calculated based on the selected attribution window. |
Mobile App Credit Spends int | app_custom_event.fb_mobile_spent_credits | The total number of credits spent within the mobile app as a result of your ad. |
Mobile App Credit Spends (Inline) int | app_custom_event.fb_mobile_spent_credits_inline | The total number of mobile app credit spends, calculated based on the selected attribution window. |
Mobile App Tutorial Completions int | app_custom_event.fb_mobile_tutorial_completion | The total number of tutorials completed within the mobile app as a result of your ad. |
Mobile App Tutorial Completions (Inline) int | app_custom_event.fb_mobile_tutorial_completion_inline | The total number of mobile app tutorial completions, calculated based on the selected attribution window. |
Other Mobile App Actions int | app_custom_event.other | The total number of other actions taken within the mobile app as a result of your ad. |
Other Mobile App Actions (Inline) int | app_custom_event.other_inline | The total number of other mobile app actions, calculated based on the selected attribution window. |
App Installs int | app_install | The total number of app installs as a result of your ad. |
App Installs (Inline) int | app_install_inline | The total number of app installs, calculated based on the selected attribution window. |
App Uses int | app_use | The total number of times the app was used as a result of your ad. |
App Uses (Inline) int | app_use_inline | The total number of app uses, calculated based on the selected attribution window. |
Check-ins int | checkin | The total number of check-ins at your location as a result of your ad. |
Check-ins (Inline) int | checkin_inline | The total number of check-ins, calculated based on the selected attribution window. |
Post Comments int | comment | The total number of comments on your posts as a result of your ad. |
Post Comments (Inline) int | comment_inline | The total number of post comments, calculated based on the selected attribution window. |
Credit Spends int | credit_spent | The total number of credits spent as a result of your ad. |
Credit Spends (Inline) int | credit_spent_inline | The total number of credits spent, calculated based on the selected attribution window. |
Game Plays int | games.plays | The total number of times games were played as a result of your ad. |
Game Plays (Inline) int | games.plays_inline | The total number of game plays, calculated based on the selected attribution window. |
Landing Page Views int | landing_page_view | The total number of views on your landing page as a result of your ad. |
Landing Page Views (Inline) int | landing_page_view_inline | The total number of landing page views, calculated based on the selected attribution window. |
Page Likes int | like | The total number of likes on your Page as a result of your ad. |
Page Likes (Inline) int | like_inline | The total number of Page likes, calculated based on the selected attribution window. |
Link Clicks int | link_click | The total number of clicks on links within your ad. |
Link Clicks (Inline) int | link_click_inline | The total number of link clicks, calculated based on the selected attribution window. |
Mobile App Installs int | mobile_app_install | The total number of mobile app installs as a result of your ad. |
Mobile App Installs (Inline) int | mobile_app_install_inline | The total number of mobile app installs, calculated based on the selected attribution window. |
Adds Payment Info int | offsite_conversion.fb_pixel_add_payment_info | The total number of times payment information was added as a result of your ad. |
Adds Payment Info (Inline) int | offsite_conversion.fb_pixel_add_payment_info_inline | The total number of times payment information was added, calculated based on the selected attribution window. |
Adds To Cart int | offsite_conversion.fb_pixel_add_to_cart | The total number of times items were added to cart as a result of your ad. |
Adds To Cart (Inline) int | offsite_conversion.fb_pixel_add_to_cart_inline | The total number of times items were added to cart, calculated based on the selected attribution window. |
Adds To Wishlist int | offsite_conversion.fb_pixel_add_to_wishlist | The total number of times items were added to wishlist as a result of your ad. |
Adds To Wishlist (Inline) int | offsite_conversion.fb_pixel_add_to_wishlist_inline | The total number of times items were added to wishlist, calculated based on the selected attribution window. |
Completed Registration int | offsite_conversion.fb_pixel_complete_registration | The total number of completed registrations as a result of your ad. |
Completed Registration (Inline) int | offsite_conversion.fb_pixel_complete_registration_inline | The total number of completed registrations, calculated based on the selected attribution window. |
Initiates Checkout int | offsite_conversion.fb_pixel_initiate_checkout | The total number of checkouts initiated as a result of your ad. |
Initiates Checkout (Inline) int | offsite_conversion.fb_pixel_initiate_checkout_inline | The total number of checkouts initiated, calculated based on the selected attribution window. |
Leads int | offsite_conversion.fb_pixel_lead | The total number of leads generated as a result of your ad. |
Leads (Inline) int | offsite_conversion.fb_pixel_lead_inline | The total number of leads, calculated based on the selected attribution window. |
Purchases int | offsite_conversion.fb_pixel_purchase | The total number of purchases made as a result of your ad. |
Purchases (Deprecated) int | purchase | This parameter is no longer supported and always returns a value from the offsite_conversion.fb_pixel_purchase field. |
Purchases (Inline) int | offsite_conversion.fb_pixel_purchase_inline | The total number of purchases, calculated based on the selected attribution window. |
Searches int | offsite_conversion.fb_pixel_search | The total number of searches performed as a result of your ad. |
Searches (Inline) int | offsite_conversion.fb_pixel_search_inline | The total number of searches, calculated based on the selected attribution window. |
Content Views int | offsite_conversion.fb_pixel_view_content | The total number of content views as a result of your ad. |
Content Views (Inline) int | offsite_conversion.fb_pixel_view_content_inline | The total number of content views, calculated based on the selected attribution window. |
On-Facebook Workflow Completions int | onsite_conversion.flow_complete | The total number of completed workflows on Facebook as a result of your ad. |
On-Facebook Workflow Completions (Inline) int | onsite_conversion.flow_complete_inline | The total number of completed workflows on Facebook, calculated based on the selected attribution window. |
Blocked Messaging Conversations int | onsite_conversion.messaging_block | The total number of messaging conversations that were blocked as a result of your ad. |
Blocked Messaging Conversations (Inline) int | onsite_conversion.messaging_block_inline | The total number of blocked messaging conversations, calculated based on the selected attribution window. |
Messaging Conversations Started int | onsite_conversion.messaging_conversation_started_7d | The total number of messaging conversations started within 7 days as a result of your ad. |
Messaging Conversations Started (Inline) int | onsite_conversion.messaging_conversation_started_7d_inline | The total number of messaging conversations started within 7 days, calculated based on the selected attribution window. |
New Messaging Conversations int | onsite_conversion.messaging_first_reply | The total number of new messaging conversations as a result of your ad. |
New Messaging Conversations (Inline) int | onsite_conversion.messaging_first_reply_inline | The total number of new messaging conversations, calculated based on the selected attribution window. |
Messaging Subscriptions int | onsite_conversion.messaging_user_subscribed | The total number of messaging subscriptions as a result of your ad. |
Messaging Subscriptions (Inline) int | onsite_conversion.messaging_user_subscribed_inline | The total number of messaging subscriptions, calculated based on the selected attribution window. |
Post Saves int | onsite_conversion.post_save | The total number of times posts were saved as a result of your ad. |
Post Saves (Inline) int | onsite_conversion.post_save_inline | The total number of post saves, calculated based on the selected attribution window. |
On-Facebook Purchases int | onsite_conversion.purchase | The total number of purchases made on Facebook as a result of your ad. |
On-Facebook Purchases (Inline) int | onsite_conversion.purchase_inline | The total number of on-Facebook purchases, calculated based on the selected attribution window. |
Page Photo Views int | photo_view | The total number of times page photos were viewed as a result of your ad. |
Page Photo Views (Inline) int | photo_view_inline | The total number of page photo views, calculated based on the selected attribution window. |
Post Shares int | post | The total number of times posts were shared as a result of your ad. |
Post Shares (Inline) int | post_inline | The total number of post shares, calculated based on the selected attribution window. |
Post Reactions int | post_reaction | The total number of reactions to your posts as a result of your ad. |
Post Reactions (Inline) int | post_reaction_inline | The total number of post reactions, calculated based on the selected attribution window. |
Event Responses int | rsvp | The total number of responses to events as a result of your ad. |
Event Responses (Inline) int | rsvp_inline | The total number of event responses, calculated based on the selected attribution window. |
3-Second Video Views int | video_view | The total number of times videos were viewed for at least 3 seconds as a result of your ad. |
3-Second Video Views (Inline) int | video_view_inline | The total number of 3-second video views, calculated based on the selected attribution window. |
Contacts int | contact_total | The total number of contacts made as a result of your ad. |
Contacts (Inline) int | contact_total_inline | The total number of contacts, calculated based on the selected attribution window. |
Website Contacts int | contact_website | The total number of website contacts made as a result of your ad. |
Website Contacts (Inline) int | contact_website_inline | The total number of website contacts, calculated based on the selected attribution window. |
Mobile App Contacts int | contact_mobile_app | The total number of mobile app contacts made as a result of your ad. |
Mobile App Contacts (Inline) int | contact_mobile_app_inline | The total number of mobile app contacts, calculated based on the selected attribution window. |
Offline Contacts int | contact_offline | The total number of offline contacts made as a result of your ad. |
Offline Contacts (Inline) int | contact_offline_inline | The total number of offline contacts, calculated based on the selected attribution window. |
Products Customized int | customize_product_total | The total number of products customized as a result of your ad. |
Products Customized (Inline) int | customize_product_total_inline | The total number of products customized, calculated based on the selected attribution window. |
Website Products Customized int | customize_product_website | The total number of website products customized as a result of your ad. |
Website Products Customized (Inline) int | customize_product_website_inline | The total number of website products customized, calculated based on the selected attribution window. |
Mobile App Products Customized int | customize_product_mobile_app | The total number of mobile app products customized as a result of your ad. |
Mobile App Products Customized (Inline) int | customize_product_mobile_app_inline | The total number of mobile app products customized, calculated based on the selected attribution window. |
Offline Products Customized int | customize_product_offline | The total number of offline products customized as a result of your ad. |
Offline Products Customized (Inline) int | customize_product_offline_inline | The total number of offline products customized, calculated based on the selected attribution window. |
Donations int | donate_total | The total number of donations made as a result of your ad. |
Donations (Inline) int | donate_total_inline | The total number of donations, calculated based on the selected attribution window. |
Website Donations int | donate_website | The total number of donations made through the website as a result of your ad. |
Website Donations (Inline) int | donate_website_inline | The total number of website donations, calculated based on the selected attribution window. |
On Facebook Donations int | donate_on_facebook | The total number of donations made on Facebook as a result of your ad. |
On Facebook Donations (Inline) int | donate_on_facebook_inline | The total number of on Facebook donations, calculated based on the selected attribution window. |
Mobile App Donations int | donate_mobile_app | The total number of donations made through the mobile app as a result of your ad. |
Mobile App Donations (Inline) int | donate_mobile_app_inline | The total number of mobile app donations, calculated based on the selected attribution window. |
Offline Donations int | donate_offline | The total number of offline donations made as a result of your ad. |
Offline Donations (Inline) int | donate_offline_inline | The total number of offline donations, calculated based on the selected attribution window. |
Location Searches int | find_location_total | The total number of location searches performed as a result of your ad. |
Location Searches (Inline) int | find_location_total_inline | The total number of location searches, calculated based on the selected attribution window. |
Website Location Searches int | find_location_website | The total number of location searches performed on the website as a result of your ad. |
Website Location Searches (Inline) int | find_location_website_inline | The total number of website location searches, calculated based on the selected attribution window. |
Mobile App Location Searches int | find_location_mobile_app | The total number of location searches performed in the mobile app as a result of your ad. |
Mobile App Location Searches (Inline) int | find_location_mobile_app_inline | The total number of mobile app location searches, calculated based on the selected attribution window. |
Offline App Location Searches int | find_location_offline | The total number of offline location searches performed as a result of your ad. |
Offline App Location Searches (Inline) int | find_location_offline_inline | The total number of offline location searches, calculated based on the selected attribution window. |
Appointments Scheduled int | schedule_total | The total number of appointments scheduled as a result of your ad. |
Appointments Scheduled (Inline) int | schedule_total_inline | The total number of appointments scheduled, calculated based on the selected attribution window. |
Website Appointments Scheduled int | schedule_website | The total number of appointments scheduled through the website as a result of your ad. |
Website Appointments Scheduled (Inline) int | schedule_website_inline | The total number of website appointments scheduled, calculated based on the selected attribution window. |
Mobile App Appointments Scheduled int | schedule_mobile_app | The total number of appointments scheduled in the mobile app as a result of your ad. |
Mobile App Appointments Scheduled (Inline) int | schedule_mobile_app_inline | The total number of mobile app appointments scheduled, calculated based on the selected attribution window. |
Offline App Appointments Scheduled int | schedule_offline | The total number of offline appointments scheduled as a result of your ad. |
Offline App Appointments Scheduled (Inline) int | schedule_offline_inline | The total number of offline appointments scheduled, calculated based on the selected attribution window. |
Trials Started int | start_trial_total | The total number of trials started as a result of your ad. |
Trials Started (Inline) int | start_trial_total_inline | The total number of trials started, calculated based on the selected attribution window. |
Website Trials Started int | start_trial_website | The total number of trials started through the website as a result of your ad. |
Website Trials Started (Inline) int | start_trial_website_inline | The total number of website trials started, calculated based on the selected attribution window. |
Mobile App Trials Started int | start_trial_mobile_app | The total number of trials started in the mobile app as a result of your ad. |
Mobile App Trials Started (Inline) int | start_trial_mobile_app_inline | The total number of mobile app trials started, calculated based on the selected attribution window. |
Offline Trials Started int | start_trial_offline | The total number of offline trials started as a result of your ad. |
Offline Trials Started (Inline) int | start_trial_offline_inline | The total number of offline trials started, calculated based on the selected attribution window. |
Applications Submitted int | submit_application_total | The total number of applications submitted as a result of your ad. |
Applications Submitted (Inline) int | submit_application_total_inline | The total number of applications submitted, calculated based on the selected attribution window. |
Website Applications Submitted int | submit_application_website | The total number of applications submitted through the website as a result of your ad. |
Website Applications Submitted (Inline) int | submit_application_website_inline | The total number of website applications submitted, calculated based on the selected attribution window. |
Mobile App Applications Submitted int | submit_application_mobile_app | The total number of applications submitted in the mobile app as a result of your ad. |
Mobile App Applications Submitted (Inline) int | submit_application_mobile_app_inline | The total number of mobile app applications submitted, calculated based on the selected attribution window. |
Offline Applications Submitted int | submit_application_offline | The total number of offline applications submitted as a result of your ad. |
Offline Applications Submitted (Inline) int | submit_application_offline_inline | The total number of offline applications submitted, calculated based on the selected attribution window. |
On Facebook Applications Submitted int | submit_application_on_facebook | The total number of applications submitted on Facebook as a result of your ad. |
On Facebook Applications Submitted (Inline) int | submit_application_on_facebook_inline | The total number of on Facebook applications submitted, calculated based on the selected attribution window. |
Subscriptions int | subscribe_total | The total number of subscriptions made as a result of your ad. |
Subscriptions (Inline) int | subscribe_total_inline | The total number of subscriptions, calculated based on the selected attribution window. |
Website Subscriptions int | subscribe_website | The total number of subscriptions made through the website as a result of your ad. |
Website Subscriptions (Inline) int | subscribe_website_inline | The total number of website subscriptions, calculated based on the selected attribution window. |
Mobile App Subscriptions int | subscribe_mobile_app | The total number of subscriptions made in the mobile app as a result of your ad. |
Mobile App Subscriptions (Inline) int | subscribe_mobile_app_inline | The total number of mobile app subscriptions, calculated based on the selected attribution window. |
Offline Subscriptions int | subscribe_offline | The total number of offline subscriptions made as a result of your ad. |
Offline Subscriptions (Inline) int | subscribe_offline_inline | The total number of offline subscriptions, calculated based on the selected attribution window. |
Recurring Subscription Payments int | recurring_subscription_payment_total | The total number of recurring subscription payments made as a result of your ad. |
Recurring Subscription Payments (Inline) int | recurring_subscription_payment_total_inline | The total number of recurring subscription payments, calculated based on the selected attribution window. |
Website Recurring Subscription Payments int | recurring_subscription_payment_website | The total number of recurring subscription payments made through the website as a result of your ad. |
Website Recurring Subscription Payments (Inline) int | recurring_subscription_payment_website_inline | The total number of website recurring subscription payments, calculated based on the selected attribution window. |
Mobile App Recurring Subscription Payments int | recurring_subscription_payment_mobile_app | The total number of recurring subscription payments made in the mobile app as a result of your ad. |
Mobile App Recurring Subscription Payments (Inline) int | recurring_subscription_payment_mobile_app_inline | The total number of mobile app recurring subscription payments, calculated based on the selected attribution window. |
Offline Recurring Subscription Payments int | recurring_subscription_payment_offline | The total number of offline recurring subscription payments made as a result of your ad. |
Offline Recurring Subscription Payments (Inline) int | recurring_subscription_payment_offline_inline | The total number of offline recurring subscription payments, calculated based on the selected attribution window. |
Canceled Subscriptions int | cancel_subscription_total | The total number of canceled subscriptions as a result of your ad. |
Canceled Subscriptions (Inline) int | cancel_subscription_total_inline | The total number of canceled subscriptions, calculated based on the selected attribution window. |
Website Canceled Subscriptions int | cancel_subscription_website | The total number of canceled subscriptions made through the website as a result of your ad. |
Website Canceled Subscriptions (Inline) int | cancel_subscription_website_inline | The total number of website canceled subscriptions, calculated based on the selected attribution window. |
Mobile App Canceled Subscriptions int | cancel_subscription_mobile_app | The total number of canceled subscriptions made in the mobile app as a result of your ad. |
Mobile App Canceled Subscriptions (Inline) int | cancel_subscription_mobile_app_inline | The total number of mobile app canceled subscriptions, calculated based on the selected attribution window. |
Offline Canceled Subscriptions int | cancel_subscription_offline | The total number of offline canceled subscriptions made as a result of your ad. |
Offline Canceled Subscriptions (Inline) int | cancel_subscription_offline_inline | The total number of offline canceled subscriptions, calculated based on the selected attribution window. |
In-App Ad Clicks int | ad_click_mobile_app | The total number of in-app ad clicks as a result of your ad. |
In-App Ad Clicks (Inline) int | ad_click_mobile_app_inline | The total number of in-app ad clicks, calculated based on the selected attribution window. |
In-App Ad Impressions int | ad_impression_mobile_app | The total number of in-app ad impressions as a result of your ad. |
In-App Ad Impressions (Inline) int | ad_impression_mobile_app_inline | The total number of in-app ad impressions, calculated based on the selected attribution window. |
Estimated Call Confirmation Clicks int | click_to_call_call_confirm | The estimated number of call confirmation clicks as a result of your ad. |
Estimated Call Confirmation Clicks (Inline) int | click_to_call_call_confirm_inline | The estimated number of call confirmation clicks, calculated based on the selected attribution window. |
Calls Placed int | click_to_call_native_call_placed | The total number of calls placed as a result of your ad. Only available in select countries. |
Calls Placed (Inline) int | click_to_call_native_call_placed_inline | The total number of calls placed, calculated based on the selected attribution window. Only available in select countries. |
20s Calls Placed int | click_to_call_native_20s_call_connect | The total number of 20-second calls placed as a result of your ad. Only available in select countries. |
20s Calls Placed (Inline) int | click_to_call_native_20s_call_connect_inline | The total number of 20-second calls placed, calculated based on the selected attribution window. Only available in select countries. |
60s Calls Placed int | click_to_call_native_60s_call_connect | The total number of 60-second calls placed as a result of your ad. Only available in select countries. |
60s Calls Placed (Inline) int | click_to_call_native_60s_call_connect_inline | The total number of 60-second calls placed, calculated based on the selected attribution window. Only available in select countries. |
Video Play Actions int | video_play_actions | The number of times your video starts to play. This is counted for each impression of a video, and excludes replays. |
Video Play Actions (Inline) int | video_play_actions_inline | The number of times your video starts to play, calculated based on the selected attribution window. This excludes replays. |
Video 30-Second Watched Actions int | video_30_sec_watched_actions | The number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. |
Video 30-Second Watched Actions (Inline) int | video_30_sec_watched_actions_inline | The number of times your video played for at least 30 seconds, calculated based on the selected attribution window. |
Video Average Time Watched Actions float | video_avg_time_watched_actions | The average time a video was played, including any time spent replaying the video for a single impression. |
Video Average Time Watched Actions (Inline) float | video_avg_time_watched_actions_inline | The average time a video was played, calculated based on the selected attribution window. |
Video 100% Watched Actions int | video_p100_watched_actions | The number of times your video was played at 100% of its length, including plays that skipped to this point. |
Video 100% Watched Actions (Inline) int | video_p100_watched_actions_inline | The number of times your video was played at 100% of its length, calculated based on the selected attribution window. |
Video 95% Watched Actions int | video_p95_watched_actions | The number of times your video was played at 95% of its length, including plays that skipped to this point. |
Video 95% Watched Actions (Inline) int | video_p95_watched_actions_inline | The number of times your video was played at 95% of its length, calculated based on the selected attribution window. |
Video 75% Watched Actions int | video_p75_watched_actions | The number of times your video was played at 75% of its length, including plays that skipped to this point. |
Video 75% Watched Actions (Inline) int | video_p75_watched_actions_inline | The number of times your video was played at 75% of its length, calculated based on the selected attribution window. |
Video 50% Watched Actions int | video_p50_watched_actions | The number of times your video was played at 50% of its length, including plays that skipped to this point. |
Video 50% Watched Actions (Inline) int | video_p50_watched_actions_inline | The number of times your video was played at 50% of its length, calculated based on the selected attribution window. |
Video 25% Watched Actions int | video_p25_watched_actions | The number of times your video was played at 25% of its length, including plays that skipped to this point. |
Video 25% Watched Actions (Inline) int | video_p25_watched_actions_inline | The number of times your video was played at 25% of its length, calculated based on the selected attribution window. |
Video Thruplay Watched Actions int | video_thruplay_watched_actions | The number of times your video was played to completion, or for at least 15 seconds. |
Video Thruplay Watched Actions (Inline) int | video_thruplay_watched_actions_inline | The number of times your video was played to completion, or for at least 15 seconds, calculated based on the selected attribution window. |
Video Thruplay Watched Actions (Inline) int | video_thruplay_watched_actions_inline | The number of times your video was played to completion, or for at least 15 seconds, calculated based on the selected attribution window. |
| Название | Имя в API | Описание |
|---|---|---|
Age text | age | The age range of the people you've reached. |
Country text | country | The country where the people you've reached are located. This is based on information, such as a person's hometown, their current city, and the geographical location where they tend to be when they visit Meta. |
Device Platform text | device_platform | The type of device, mobile or desktop, used by people when they viewed or clicked on an ad, as shown in ads reporting. |
Impression Device text | impression_device | The device where your last ad was served to someone on Meta. For example 'iPhone' if someone viewed your ad on an iPhone. |
Platform Position text | platform_position | Where your ad was shown within a platform, for example on Facebook desktop Feed, or Instagram Mobile Feed. |
Publisher Platform text | publisher_platform | Which platform your ad was shown, for example on Facebook, Instagram, or Audience Network. |
DMA (Designated Market Area) text | dma | The Designated Market Area (DMA) regions are the 210 geographic areas in the United States in which local television viewing is measured by The Nielsen Company. |
Frequency Value float | frequency | The number of times an ad in your Reach and Frequency campaign was served to each Accounts Center account. |
Gender text | gender | Gender of people you've reached. People who don't list their gender are shown as 'not specified'. |
Hourly Stats Aggregated by Advertiser Time Zone text | hourly_stats_aggregated_by_advertiser_time_zone | Hourly breakdown aggregated by the time ads were delivered in the advertiser's time zone. |
Hourly Stats Aggregated by Audience Time Zone text | hourly_stats_aggregated_by_audience_time_zone | Hourly breakdown aggregated by the time ads were delivered in the audiences' time zone. |
Place Page ID text | place_page_id | The ID of the place page involved in impression or click. |
Product ID text | product_id | The ID of the product involved in impression, click, or action. |
Region text | region | The regions where the people you've reached are located. This is based on information such as a person's hometown, their current city and the geographical location where they tend to be when they visit Facebook. |
| Название | Имя в API | Описание |
|---|---|---|
Action Device text | action_device | The device on which the conversion event you're tracking occurred. For example, 'Desktop' if someone converted on a desktop computer. |
Standard Event Content Type text | standard_event_content_type | The type of content involved in the standard event, such as product categories or types. |
Action Canvas Component Name text | action_canvas_component_name | Name of a component within a Canvas ad. |
Action Carousel Card ID text | action_carousel_card_id | The ID of the specific carousel card that people engaged with when they saw your ad. |
Action Carousel Card Name text | action_carousel_card_name | The specific carousel card that people engaged with when they saw your ad. The cards are identified by their headlines. |
Action Destination text | action_destination | The destination where people go after clicking on your ad. This could be your Facebook Page, an external URL for your conversion pixel or an app configured with the software development kit (SDK). |
Action Reaction int | action_reaction | The number of reactions on your ads or boosted posts. The reactions button on an ad allows people to share different reactions on its content: Like, Love, Haha, Wow, Sad or Angry. |
Action Target ID text | action_target_id | The ID of destination where people go after clicking on your ad. This could be your Facebook Page, an external URL for your conversion pixel or an app configured with the software development kit (SDK). |
Action Type text | action_type | The kind of actions taken on your ad, page, app or event after your ad was served to someone, even if they didn't click on it. Action types include page likes, app installs, conversions, event responses, and more. |
Action Video Sound text | action_video_sound | The sound status (on/off) when someone plays your video ad. |
Action Video Type text | action_video_type | Video metrics breakdown. |
| Название | Имя в API | Описание |
|---|---|---|
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 |
| Название | Имя в API | Описание |
|---|---|---|
Campaign ID text | id | Campaign’s ID |
Account ID text | account_id | ID of the ad account that owns this campaign |
Bid Strategy text | bid_strategy | Bid strategy for AUCTION and campaign budget optimization:
- LOWEST_COST_WITHOUT_CAP: Maximize results without bid limit. Known as automatic bidding.
- LOWEST_COST_WITH_BID_CAP: Maximize results with bid limit in bid_amount. Known as manual max-cost bidding.
- COST_CAP: Maximize results with average cost limit in bid_amount. Notes: - Without campaign budget optimization, get bid_strategy at ad set level. - TARGET_COST bidding strategy deprecated with API v9. |
Boosted Object ID text | boosted_object_id | The Boosted Object this campaign has associated, if any |
Budget Rebalance Flag bool | budget_rebalance_flag | Whether to automatically rebalance budgets daily for all the adsets under this campaign. This has been deprecated on Marketing API V7.0. |
Budget Remaining float | budget_remaining | Remaining budget |
Buying Type text | buying_type | Buying type, possible values are: AUCTION: default RESERVED: for reach and frequency ads. Reach and Frequency is disabled for housing, employment and credit ads. |
Campaign Group Active Time int | campaign_group_active_time | campaign_group_active_time this is only for Internal, This will have the active running length of Campaign Groups |
Can Create Brand Lift Study bool | can_create_brand_lift_study | If we can create a new automated brand lift study for the ad set. |
Can Use Spend Cap bool | can_use_spend_cap | Whether the campaign can set the spend cap |
Configured Status text | configured_status | If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. Prefer using 'status' instead of this. |
Created Time datetime | created_time | Created Time |
Daily Budget float | daily_budget | The daily budget of the campaign |
Effective Status text | effective_status | IN_PROCESS is available for version 4.0 or higher |
Has Secondary SKAdNetwork Reporting bool | has_secondary_skadnetwork_reporting | has_secondary_skadnetwork_reporting |
Is Budget Schedule Enabled bool | is_budget_schedule_enabled | Whether budget scheduling is enabled for the campaign group |
Is SKAdNetwork Attribution bool | is_skadnetwork_attribution | When set to true Indicates that the campaign will include SKAdNetwork, iOS 14+. |
Last Budget Toggling Time datetime | last_budget_toggling_time | Last budget toggling time |
Lifetime Budget float | lifetime_budget | The lifetime budget of the campaign |
Name text | name | Campaign's name |
Objective text | objective | Campaign's objective |
Primary Attribution text | primary_attribution | primary_attribution |
Smart Promotion Type text | smart_promotion_type | Smart Promotion Type. guided_creation or smart_app_promotion(the choice under APP_INSTALLS objective). |
Source Campaign ID text | source_campaign_id | The source campaign id that this campaign is copied from |
Special Ad Category text | special_ad_category | The campaign's Special Ad Category. One of HOUSING, EMPLOYMENT, CREDIT, or NONE. |
Spend Cap float | spend_cap | A spend cap for the campaign, such that it will not spend more than this cap. Expressed as integer value of the subunit in your currency. |
Start Time datetime | start_time | Merging of start_times for the ad sets belonging to this campaign. At the campaign level, start_time is a read only field. You can setup start_time at the ad set level. |
Status text | status | If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. The field returns the same value as ‘configured_status’, and is the suggested one to use. |
Stop Time datetime | stop_time | Merging of stop_times for the ad sets belonging to this campaign, if available. At the campaign level, stop_time is a read only field. You can setup stop_time at the ad set level. |
Topline ID text | topline_id | Topline ID |
Updated Time datetime | updated_time | Updated Time. If you update spend_cap or daily budget or lifetime budget, this will not automatically update this field. |
| Название | Имя в API | Описание |
|---|---|---|
Ad Set ID text | id | Ad set’s ID |
Account ID text | account_id | ID of the ad account that owns this ad set |
Ad Labels array_string | adlabels | Labels associated with the ad set |
Bid Amount float | bid_amount | Bid amount for the ad set |
Billing Event text | billing_event | Billing event for the ad set |
Budget Remaining float | budget_remaining | Remaining budget for the ad set |
Campaign ID text | campaign_id | ID of the campaign associated with this ad set |
Configured Status text | configured_status | Configured status of the ad set |
Created Time datetime | created_time | Time when the ad set was created |
Creative Sequence array_string | creative_sequence | Creative sequence for the ad set |
Daily Budget float | daily_budget | Daily budget for the ad set |
Effective Status text | effective_status | Effective status of the ad set |
End Time datetime | end_time | End time for the ad set |
Frequency Cap int | frequency_cap | Frequency cap for the ad set |
Frequency Cap Reset Period int | frequency_cap_reset_period | Frequency cap reset period for the ad set |
Is Dynamic Creative bool | is_dynamic_creative | Whether the ad set is using dynamic creative |
Lifetime Budget float | lifetime_budget | Lifetime budget for the ad set |
Name text | name | Name of the ad set |
Optimization Goal text | optimization_goal | Optimization goal for the ad set |
Pacing Type array_string | pacing_type | Pacing type for the ad set |
Recommendations array_string | recommendations | Recommendations for the ad set |
Recurring Budget Semantics bool | recurring_budget_semantics | Recurring budget semantics for the ad set |
RF Prediction ID text | rf_prediction_id | RF prediction ID for the ad set |
Start Time datetime | start_time | Start time for the ad set |
Status text | status | Status of the ad set |
Updated Time datetime | updated_time | Time when the ad set was last updated |
| Название | Имя в API | Описание |
|---|---|---|
Ad ID text | id | Ad’s ID |
Account ID text | account_id | ID of the ad account that owns this ad |
Ad Review Feedback text | ad_review_feedback | Feedback from the review process for the ad |
Ad Set ID text | adset_id | ID of the ad set associated with this ad |
Bid Amount float | bid_amount | Bid amount for the ad |
Campaign ID text | campaign_id | ID of the campaign associated with this ad |
Configured Status text | configured_status | Configured status of the ad |
Conversion Domain text | conversion_domain | Domain used for conversion tracking |
Created Time datetime | created_time | Time when the ad was created |
Effective Status text | effective_status | Effective status of the ad |
Last Updated by App ID text | last_updated_by_app_id | ID of the app that last updated the ad |
Name text | name | Name of the ad |
Preview Shareable Link text | preview_shareable_link | Shareable link for previewing the ad |
Source Ad ID text | source_ad_id | ID of the source ad from which this ad was copied |
Status text | status | Status of the ad |
Updated Time datetime | updated_time | Time when the ad was last updated |
| Название | Имя в API | Описание |
|---|---|---|
Ad Account ID text | id | Unique string-based Ad Account ID (act_{ad_account_id}) |
Numeric Account ID text | account_id | Numeric ID of the Ad Account |
Account Status int | account_status | Current status of the Ad Account |
Account Age float | age | Age of the Ad Account in days |
Amount Spent text | amount_spent | Total amount spent by this account |
Balance text | balance | Outstanding balance on the account |
Brand Safety Filters array_string | brand_safety_content_filter_levels | List of brand safety content filter levels |
Business City text | business_city | City from business address |
Business Country Code text | business_country_code | Country code of the business |
Business Name text | business_name | Name of the business |
Business State text | business_state | State of business address |
Business Street text | business_street | Street address line 1 |
Business Street 2 text | business_street2 | Street address line 2 |
Business ZIP Code text | business_zip | Postal code of the business address |
Brand Lift Eligibility bool | can_create_brand_lift_study | Can create automated brand lift study |
Created Time datetime | created_time | Creation time of the ad account |
Currency text | currency | Currency used in the ad account |
Default DSA Beneficiary text | default_dsa_beneficiary | Default beneficiary for DSA L2 objects |
Default DSA Payor text | default_dsa_payor | Default payor for DSA L2 objects |
Disable Reason int | disable_reason | Reason why account was disabled (if applicable) |
End Advertiser ID text | end_advertiser | ID of the end advertiser |
End Advertiser Name text | end_advertiser_name | Name of the end advertiser |
Existing Customers array_string | existing_customers | List of custom audience IDs for existing customers |
Facebook Entity int | fb_entity | Internal Facebook entity ID |
Funding Source text | funding_source | ID of the funding source |
Migrated Permissions bool | has_migrated_permissions | Whether permissions have been migrated |
Insertion Order Number text | io_number | IO number for billing |
Attribution Spec System Default bool | is_attribution_spec_system_default | If attribution spec is from system defaults |
Direct Deals Enabled bool | is_direct_deals_enabled | Whether direct deals are enabled |
3DS Market Authorization Enabled bool | is_in_3ds_authorization_enabled_market | Is 3DS required for this market |
Notifications Enabled bool | is_notifications_enabled | Are notifications enabled for the user |
Is Personal Account int | is_personal | Is the ad account personal/non-business |
Is Prepay Account bool | is_prepay_account | Is this a prepay ad account |
Tax ID Required bool | is_tax_id_required | Whether tax ID is required for this account |
Line Numbers array_int | line_numbers | List of billing line numbers |
Media Agency text | media_agency | Media agency identifier |
Minimum Campaign Spend Cap text | min_campaign_group_spend_cap | Minimum required spend cap for campaign groups |
Minimum Daily Budget int | min_daily_budget | Minimum daily budget allowed for this account |
Account Name text | name | Name of the ad account |
Offsite Pixels ToS Accepted bool | offsite_pixels_tos_accepted | Whether offsite pixel terms were accepted |
Account Owner text | owner | User ID of the account owner |
Partner text | partner | Marketing partner for the account |
Spend Cap text | spend_cap | Maximum spend limit for the account |
Tax ID text | tax_id | Tax identification number |
Tax ID Status int | tax_id_status | Status of VAT or tax ID |
Tax ID Type text | tax_id_type | Type of tax ID (e.g., VAT) |
Timezone ID int | timezone_id | Numeric timezone ID |
Timezone Name text | timezone_name | Name of the timezone |
Timezone Offset (UTC) float | timezone_offset_hours_utc | Timezone offset from UTC in hours |
User Tasks array_string | user_tasks | List of user task assignments for this account |
Добавьте такие поля, как Date, Clicks, Impressions, Spend и различные ID для построения аналитических отчетов.
Динамические параметры в ссылках
Renta автоматически извлекает UTM-метки из шаблонов или прямых URL объявлений. При парсинге поддерживаются следующие динамические параметры:
| Плейсхолдер URL | Поле данных | Описание |
|---|---|---|
| ad.id | ad_id | Уникальный идентификатор объявления |
| ad.name | ad_name | Название объявления |
| adset.id | adset_id | Уникальный идентификатор группы объявлений |
| adset.name | adset_name | Название группы объявлений |
| campaign.id | campaign_name | ID кампании (в данный момент мапится в campaign_name) |
| campaign.name | campaign_name | Название рекламной кампании |
Эти плейсхолдеры подставляются в стандартные UTM-параметры: utm_medium, utm_source, utm_campaign, utm_content и utm_term.
Пример использования в URL объявления:
https://example.com/landing?utm_source=facebook&utm_campaign={{campaign.name}}&utm_content={{ad.name}}В отчетах по статистике эти плейсхолдеры автоматически заменяются на реальные значения для каждого объявления.
Date Range
В этом разделе вы можете определить временной интервал, за который будут извлечены исторические данные.
Выберите период для выгрузки данных. Renta позволяет выгружать исторические данные за любой выбранный период без ограничений.
Overwrite period
Настройка окна перезаписи позволяет автоматически обновлять данные за прошедшие дни для учета корректировок.
Выберите период времени, который будет перезаписываться. Каждый день данные за этот период будут удаляться и загружаться заново, что гарантирует целостность данных и учет долетевших конверсий.
Расписание синхронизации
Для автоматизации процесса обновления данных Renta предоставляет гибкие настройки расписания.
Стратегия синхронизации
В зависимости от типа отчета платформа применяет оптимальный метод обновления данных в вашем хранилище.
В следующей таблице описаны стратегии синхронизации, используемые Renta для Facebook Ads:
| Стратегия | Описание |
|---|---|
| Incremental load | Renta будет постоянно синхронизировать ваши данные инкрементально, при условии, что поле Date выбрано в параметрах.Поддерживаемые отчеты: Statistics report если выбрано поле Date. |
| Full overwrite | Renta полностью перезаписывает весь датасет при каждой синхронизации, поскольку эти отчеты представляют собой снимки конфигурации без временных свойств, или поле даты не выбрано. Поддерживаемые отчеты: Campaign metadata, Ad group metadata, Ad metadata, Ad account metadata, а также Statistics report когда поле Date не выбрано. |
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.