JDBC Driver for Facebook Ads

Build 22.0.8462

CreateAdInsightsReport

Generates a report schema for ad insights.

Input

Name Type Accepts Output Streams Description
ReportName String False The name of the report.
Description String False An optional description for the report.
Fields String False Comma-delimited list of non-breakdown fields for your report. Available values: AccountCurrency,ActionValue,AdAccountId,AdAccountName,CampaignID,CampaignName,AdSetId,AdSetname,AdId,AdName,BuyingType,Clicks,ConversionRateRanking,CostPerEstimatedAdRecallers,CostPerInlineLinkClick,CostPerInlinePostEngagement,CostPerUniqueClick,CostPerUniqueInlineLinkClick,CPC,CPM,CPP,EstimatedAdRecallRate,EstimatedAdRecallers,Frequency,Impressions,InlineLinkClicks,InlineLinkClicksCounter,InlinePostEngagement,InstantExperienceClicksToOpen,InstantExperienceClicksToStart,InstantExperienceOutboundClicks,Objective,QualityRanking,Reach,Spend,UniqueClicks,UniqueCTR,UniqueInlineLinkClicks,UniqueInlineLinkClickCounter,UniqueLinkClicksCounter

The default value is AccountCurrency,AdAccountId,AdAccountName,CampaignID,CampaignName,AdSetId,AdSetname,AdId,AdName,BuyingType,Clicks,CostPerInlineLinkClick,CostPerInlinePostEngagement,CostPerUniqueClick,CostPerUniqueInlineLinkClick,CPC,CPM,CPP,Frequency,Impressions,InlineLinkClicks,InlineLinkClicksCounter,InlinePostEngagement,Reach,Spend.

Breakdowns String False Breakdowns for your report. Available values: Age,Country,DevicePlatform,DMA,FrequencyValue,Gender,HStatsByAdvertiserTZ,HStatsByAudienceTZ,ImpressionDevice,PlacePageId,PlatformPosition,ProductId,PublisherPlatform,Region
ActionBreakdowns String False Action breakdowns for your report. Available values: ActionCanvasComponentName,ActionCarouselCardId,ActionCarouselCardName,ActionConvertedProductId,ActionDestination,ActionDevice,ActionReaction,ActionTargetId,ActionType,ActionVideoSound,ActionVideoType
ActionCollection String False Collections of ads actions stats to return for your report. The available values are: ActionValues, Actions, AdClickActions, AdImpressionActions, CatalogSegmentActions, CatalogSegmentValue, CatalogSegmentValueMobilePurchaseRoas, CatalogSegmentValueOmniPurchaseRoas, CatalogSegmentValueWebsitePurchaseRoas, ConversionValues, Conversions, ConvertedProductQuantity, ConvertedProductValue, CostPer15_secVideoView, CostPer2SecContinuousVideoView, CostPerActionType, CostPerAdClick, CostPerConversion, CostPerOneThousandAdImpression, CostPerOutboundClick, CostPerStoreVisitAction, CostPerThruplay, CostPerUniqueActionType, CostPerUniqueConversion, CostPerUniqueOutboundClick, InteractiveComponentTap, MobileAppPurchaseRoas, OutboundClicks, OutboundClicksCtr, PurchaseRoas, StoreVisitActions, UniqueActions, UniqueConversions, UniqueOutboundClicks, UniqueOutboundClicksCtr, UniqueVideoView15_sec, Video15_secWatchedActions, Video30_secWatchedActions, VideoAvgTimeWatchedActions, VideoContinuous2SecWatchedActions, VideoP100_watchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoP95WatchedActions, VideoPlayActions, VideoPlayCurveActions, VideoPlayRetention0To15SActions, VideoPlayRetention20_to60SActions, VideoPlayRetentionGraphActions, VideoTimeWatchedActions, WebsiteCtr, WebsitePurchaseRoas

The default value is Actions.

ActionAttributionWindows String False A comma separated list which determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default is [1d_view,7d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default.

The default value is default.

DatePreset String False 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.

The default value is maximum.

TimeIncrement String False 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 90.

FileStream String True An instance of an output stream where file data is written to.
OutputDirectory String False The directory where the schema file will be written. If no directory is specified, the generated report will be written to the FileData output.

Result Set Columns

Name Type Description
Result String Success or Failure.
SchemaFile String The generated schema file.
Columns String The number of columns found.
FileData String The BASE64 downloaded file content. Only returned if SchemaDirectory and FileStream is not set.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462