CData Python Connector for Facebook Ads

Build 23.0.8839

Action_Video_Sound_Report

Ad Report focusing on video consumption, broken down by sound status. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

The default value is 1.

Level String The level to represent the results at.

The allowed values are ad, adset, campaign, account.

ActionValue Integer Metric value of default attribution window.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection String The action collection to retrieve. The available values are: Video30SecWatchedActions, VideoAvgTimeWatchedActions, VideoP100WatchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoThruplayWatchedActions
ActionVideoSound String The sound status (on/off) when user watches your video ad.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839