@owox/connectors 0.12.0-next-20251104091845 → 0.12.0-next-20251104125401

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.cjs +2404 -139
  2. package/dist/index.js +2404 -139
  3. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -16438,75 +16438,2266 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
16438
16438
  "description": "Time when the ad was created.",
16439
16439
  "type": "datetime"
16440
16440
  },
16441
- "creative": {
16442
- "description": "This field is required for create. The ID or creative spec of the ad creative to be used by this ad. You can read more about creatives here. You may supply the ID within an object as follows:",
16443
- "type": "AdCreative"
16441
+ "creative_id": {
16442
+ "description": "Unique ID for the ad creative",
16443
+ "type": "string",
16444
+ "apiName": "creative.id"
16445
+ },
16446
+ "creative_effective_object_story_id": {
16447
+ "description": "The ID of a page post to use in an ad, regardless of whether its an organic or unpublished page post",
16448
+ "type": "string",
16449
+ "apiName": "creative.effective_object_story_id"
16450
+ },
16451
+ "creative_name": {
16452
+ "description": "Name of the ad creative as seen in the ad accounts library",
16453
+ "type": "string",
16454
+ "apiName": "creative.name"
16455
+ },
16456
+ "creative_object_story_spec": {
16457
+ "description": "Object story spec containing page_id and other details",
16458
+ "type": "string",
16459
+ "apiName": "creative.object_story_spec"
16460
+ },
16461
+ "creative_url_tags": {
16462
+ "description": "A set of query string parameters which will replace or be appended to urls clicked from page post ads",
16463
+ "type": "string",
16464
+ "apiName": "creative.url_tags"
16465
+ },
16466
+ "creative_asset_groups_spec": {
16467
+ "description": "This field is used to create ads using the Flexible ad format. You can read more about that here",
16468
+ "type": "AdCreativeAssetGroupsSpec"
16469
+ },
16470
+ "effective_status": {
16471
+ "description": "The effective status of the ad. The status could be effective either because of its own status, or the status of its parent units. WITH_ISSUES is available for version 3.2 or higher. IN_PROCESS is available for version 4.0 or higher",
16472
+ "type": "enum {ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED, IN_PROCESS, WITH_ISSUES}"
16473
+ },
16474
+ "issues_info": {
16475
+ "description": "Issues for this ad that prevented it from delivering",
16476
+ "type": "list<AdgroupIssuesInfo>"
16477
+ },
16478
+ "last_updated_by_app_id": {
16479
+ "description": "Indicates the app used for the most recent update of the ad.",
16480
+ "type": "id"
16481
+ },
16482
+ "name": {
16483
+ "description": "Name of the ad.",
16484
+ "type": "string"
16485
+ },
16486
+ "preview_shareable_link": {
16487
+ "description": "A link that enables users to preview ads in different placements",
16488
+ "type": "string"
16489
+ },
16490
+ "recommendations": {
16491
+ "description": "If there are recommendations for this ad, this field includes them. Otherwise, it is not included in the response. Field not included in redownload mode.",
16492
+ "type": "list<AdRecommendation>"
16493
+ },
16494
+ "source_ad": {
16495
+ "description": "The source ad that this ad is copied from",
16496
+ "type": "Ad"
16497
+ },
16498
+ "source_ad_id": {
16499
+ "description": "The source ad id that this ad is copied from",
16500
+ "type": "numeric string"
16501
+ },
16502
+ "status": {
16503
+ "description": "The configured status of the ad. The field returns the same value as configured_status. Use this field, instead of configured_status.",
16504
+ "type": "enum {ACTIVE, PAUSED, DELETED, ARCHIVED}"
16505
+ },
16506
+ "tracking_specs": {
16507
+ "description": "With tracking specs, you log actions taken by people on your ad. This field takes arguments identical to action spec. See Tracking and Conversion Specs.",
16508
+ "type": "list<ConversionActionQuery>"
16509
+ },
16510
+ "updated_time": {
16511
+ "description": "Time when this ad was updated.",
16512
+ "type": "datetime"
16513
+ }
16514
+ };
16515
+ var adAccountUserFields = {
16516
+ "id": {
16517
+ "description": "ID of the App Scoped User",
16518
+ "type": "numeric string"
16519
+ },
16520
+ "name": {
16521
+ "description": "User public full name",
16522
+ "type": "string"
16523
+ }
16524
+ // Commented because this field is lead to mistake despite to presence in schema.
16525
+ // 'tasks': {
16526
+ // 'description': 'Tasks of App Scoped User',
16527
+ // 'type': 'list<string>'
16528
+ // }
16529
+ };
16530
+ var adAccountInsightsFields = {
16531
+ "account_currency": {
16532
+ "description": "Currency that is used by your ad account.",
16533
+ "type": "string"
16534
+ },
16535
+ "account_id": {
16536
+ "description": "The ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.",
16537
+ "type": "numeric string",
16538
+ "GoogleSheetsFormat": "@"
16539
+ },
16540
+ "account_name": {
16541
+ "description": "The name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.",
16542
+ "type": "string"
16543
+ },
16544
+ "action_values": {
16545
+ "description": "The total value of all conversions attributed to your ads.",
16546
+ "type": "list<AdsActionStats>"
16547
+ },
16548
+ "actions": {
16549
+ "description": "The total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.",
16550
+ "type": "list<AdsActionStats>"
16551
+ },
16552
+ "ad_click_actions": {
16553
+ "description": "ad_click_actions",
16554
+ "type": "list<AdsActionStats>"
16555
+ },
16556
+ "ad_id": {
16557
+ "description": "The unique ID of the ad you're viewing in reporting.",
16558
+ "type": "numeric string",
16559
+ "GoogleSheetsFormat": "@"
16560
+ },
16561
+ "ad_impression_actions": {
16562
+ "description": "ad_impression_actions",
16563
+ "type": "list<AdsActionStats>"
16564
+ },
16565
+ "ad_name": {
16566
+ "description": "The name of the ad you're viewing in reporting.",
16567
+ "type": "string"
16568
+ },
16569
+ "adset_id": {
16570
+ "description": "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.",
16571
+ "type": "numeric string",
16572
+ "GoogleSheetsFormat": "@"
16573
+ },
16574
+ "adset_name": {
16575
+ "description": "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.",
16576
+ "type": "string"
16577
+ },
16578
+ "attribution_setting": {
16579
+ "description": "The default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.",
16580
+ "type": "string"
16581
+ },
16582
+ "auction_bid": {
16583
+ "description": "auction_bid",
16584
+ "type": "numeric string",
16585
+ "GoogleBigQueryType": "numeric"
16586
+ },
16587
+ "auction_competitiveness": {
16588
+ "description": "auction_competitiveness",
16589
+ "type": "numeric string",
16590
+ "GoogleBigQueryType": "numeric"
16591
+ },
16592
+ "auction_max_competitor_bid": {
16593
+ "description": "auction_max_competitor_bid",
16594
+ "type": "numeric string",
16595
+ "GoogleBigQueryType": "numeric"
16596
+ },
16597
+ "buying_type": {
16598
+ "description": "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. This field is currently only visible at the campaign level.",
16599
+ "type": "string"
16600
+ },
16601
+ "campaign_id": {
16602
+ "description": "The unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.",
16603
+ "type": "numeric string",
16604
+ "GoogleSheetsFormat": "@"
16605
+ },
16606
+ "campaign_name": {
16607
+ "description": "The name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.",
16608
+ "type": "string"
16609
+ },
16610
+ "canvas_avg_view_percent": {
16611
+ "description": "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. It may include a series of interactive or multimedia components, including video, images product catalog and more.",
16612
+ "type": "numeric string",
16613
+ "GoogleBigQueryType": "numeric"
16614
+ },
16615
+ "canvas_avg_view_time": {
16616
+ "description": "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. It may include a series of interactive or multimedia components, including video, images product catalog and more.",
16617
+ "type": "numeric string",
16618
+ "GoogleBigQueryType": "numeric"
16619
+ },
16620
+ "catalog_segment_actions": {
16621
+ "description": "The number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.",
16622
+ "type": "list<AdsActionStats>"
16623
+ },
16624
+ "catalog_segment_value": {
16625
+ "description": "The total value of all conversions from your catalog segment attributed to your ads.",
16626
+ "type": "list<AdsActionStats>"
16627
+ },
16628
+ "catalog_segment_value_mobile_purchase_roas": {
16629
+ "description": "The total return on ad spend (ROAS) from mobile app purchases for your catalog segment.",
16630
+ "type": "list<AdsActionStats>"
16631
+ },
16632
+ "catalog_segment_value_omni_purchase_roas": {
16633
+ "description": "The total return on ad spend (ROAS) from all purchases for your catalog segment.",
16634
+ "type": "list<AdsActionStats>"
16635
+ },
16636
+ "catalog_segment_value_website_purchase_roas": {
16637
+ "description": "The total return on ad spend (ROAS) from website purchases for your catalog segment.",
16638
+ "type": "list<AdsActionStats>"
16639
+ },
16640
+ "clicks": {
16641
+ "description": "The number of clicks on your ads.",
16642
+ "type": "numeric string",
16643
+ "GoogleBigQueryType": "numeric"
16644
+ },
16645
+ "conversion_values": {
16646
+ "description": "conversion_values",
16647
+ "type": "list<AdsActionStats>"
16648
+ },
16649
+ "conversions": {
16650
+ "description": "conversions",
16651
+ "type": "list<AdsActionStats>"
16652
+ },
16653
+ "converted_product_quantity": {
16654
+ "description": "The number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.",
16655
+ "type": "list<AdsActionStats>"
16656
+ },
16657
+ "converted_product_value": {
16658
+ "description": "The value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.",
16659
+ "type": "list<AdsActionStats>"
16660
+ },
16661
+ "cost_per_15_sec_video_view": {
16662
+ "description": "cost_per_15_sec_video_view",
16663
+ "type": "list<AdsActionStats>"
16664
+ },
16665
+ "cost_per_2_sec_continuous_video_view": {
16666
+ "description": "cost_per_2_sec_continuous_video_view",
16667
+ "type": "list<AdsActionStats>"
16668
+ },
16669
+ "cost_per_action_type": {
16670
+ "description": "The average cost of a relevant action.",
16671
+ "type": "list<AdsActionStats>"
16672
+ },
16673
+ "cost_per_ad_click": {
16674
+ "description": "cost_per_ad_click",
16675
+ "type": "list<AdsActionStats>"
16676
+ },
16677
+ "cost_per_conversion": {
16678
+ "description": "cost_per_conversion",
16679
+ "type": "list<AdsActionStats>"
16680
+ },
16681
+ "cost_per_dda_countby_convs": {
16682
+ "description": "cost_per_dda_countby_convs",
16683
+ "type": "numeric string",
16684
+ "GoogleBigQueryType": "numeric"
16685
+ },
16686
+ "cost_per_inline_link_click": {
16687
+ "description": "The average cost of each inline link click.",
16688
+ "type": "numeric string",
16689
+ "GoogleBigQueryType": "numeric"
16690
+ },
16691
+ "cost_per_inline_post_engagement": {
16692
+ "description": "The average cost of each inline post engagement.",
16693
+ "type": "numeric string",
16694
+ "GoogleBigQueryType": "numeric"
16695
+ },
16696
+ "cost_per_one_thousand_ad_impression": {
16697
+ "description": "cost_per_one_thousand_ad_impression",
16698
+ "type": "list<AdsActionStats>"
16699
+ },
16700
+ "cost_per_outbound_click": {
16701
+ "description": "The average cost for each outbound click.",
16702
+ "type": "list<AdsActionStats>"
16703
+ },
16704
+ "cost_per_thruplay": {
16705
+ "description": "The average cost for each ThruPlay. This metric is in development.",
16706
+ "type": "list<AdsActionStats>"
16707
+ },
16708
+ "cost_per_unique_action_type": {
16709
+ "description": "The average cost of each unique action. This metric is estimated.",
16710
+ "type": "list<AdsActionStats>"
16711
+ },
16712
+ "cost_per_unique_click": {
16713
+ "description": "The average cost for each unique click (all). This metric is estimated.",
16714
+ "type": "numeric string",
16715
+ "GoogleBigQueryType": "numeric"
16716
+ },
16717
+ "cost_per_unique_conversion": {
16718
+ "description": "cost_per_unique_conversion",
16719
+ "type": "list<AdsActionStats>"
16720
+ },
16721
+ "cost_per_unique_inline_link_click": {
16722
+ "description": "The average cost of each unique inline link click. This metric is estimated.",
16723
+ "type": "numeric string",
16724
+ "GoogleBigQueryType": "numeric"
16725
+ },
16726
+ "cost_per_unique_outbound_click": {
16727
+ "description": "The average cost for each unique outbound click. This metric is estimated.",
16728
+ "type": "list<AdsActionStats>"
16729
+ },
16730
+ "cpc": {
16731
+ "description": "The average cost for each click (all).",
16732
+ "type": "numeric string",
16733
+ "GoogleBigQueryType": "numeric"
16734
+ },
16735
+ "cpm": {
16736
+ "description": "The average cost for 1,000 impressions.",
16737
+ "type": "numeric string",
16738
+ "GoogleBigQueryType": "numeric"
16739
+ },
16740
+ "cpp": {
16741
+ "description": "The average cost to reach 1,000 people. This metric is estimated.",
16742
+ "type": "numeric string",
16743
+ "GoogleBigQueryType": "numeric"
16744
+ },
16745
+ "created_time": {
16746
+ "description": "created_time",
16747
+ "type": "string"
16748
+ },
16749
+ "ctr": {
16750
+ "description": "The percentage of times people saw your ad and performed a click (all).",
16751
+ "type": "numeric string",
16752
+ "GoogleBigQueryType": "numeric"
16753
+ },
16754
+ "date_start": {
16755
+ "description": "The start date for your data. This is controlled by the date range you've selected for your reporting view.",
16756
+ "type": "string",
16757
+ "GoogleBigQueryType": "date",
16758
+ "GoogleBigQueryPartitioned": true
16759
+ },
16760
+ "date_stop": {
16761
+ "description": "The end date for your data. This is controlled by the date range you've selected for your reporting view.",
16762
+ "type": "string",
16763
+ "GoogleBigQueryType": "date"
16764
+ },
16765
+ "dda_countby_convs": {
16766
+ "description": "dda_countby_convs",
16767
+ "type": "numeric string",
16768
+ "GoogleBigQueryType": "numeric"
16769
+ },
16770
+ "dda_results": {
16771
+ "description": "dda_results",
16772
+ "type": "list<AdsInsightsDdaResult>"
16773
+ },
16774
+ "frequency": {
16775
+ "description": "The average number of times each person saw your ad. This metric is estimated.",
16776
+ "type": "numeric string",
16777
+ "GoogleBigQueryType": "numeric"
16778
+ },
16779
+ "full_view_impressions": {
16780
+ "description": "The number of Full Views on your Page's posts as a result of your ad.",
16781
+ "type": "numeric string",
16782
+ "GoogleBigQueryType": "numeric"
16783
+ },
16784
+ "full_view_reach": {
16785
+ "description": "The number of people who performed a Full View on your Page's post as a result of your ad.",
16786
+ "type": "numeric string",
16787
+ "GoogleBigQueryType": "numeric"
16788
+ },
16789
+ "impressions": {
16790
+ "description": "The number of times your ads were on screen.",
16791
+ "type": "numeric string",
16792
+ "GoogleBigQueryType": "numeric"
16793
+ },
16794
+ "inline_link_click_ctr": {
16795
+ "description": "The percentage of time people saw your ads and performed an inline link click.",
16796
+ "type": "numeric string",
16797
+ "GoogleBigQueryType": "numeric"
16798
+ },
16799
+ "inline_link_clicks": {
16800
+ "description": "The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties. Inline link clicks use a fixed 1-day-click attribution window.",
16801
+ "type": "numeric string",
16802
+ "GoogleBigQueryType": "numeric"
16803
+ },
16804
+ "inline_post_engagement": {
16805
+ "description": "The total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.",
16806
+ "type": "numeric string",
16807
+ "GoogleBigQueryType": "numeric"
16808
+ },
16809
+ "instagram_upcoming_event_reminders_set": {
16810
+ "description": "instagram_upcoming_event_reminders_set",
16811
+ "type": "numeric string",
16812
+ "GoogleBigQueryType": "numeric"
16813
+ },
16814
+ "instant_experience_clicks_to_open": {
16815
+ "description": "instant_experience_clicks_to_open",
16816
+ "type": "numeric string",
16817
+ "GoogleBigQueryType": "numeric"
16818
+ },
16819
+ "instant_experience_clicks_to_start": {
16820
+ "description": "instant_experience_clicks_to_start",
16821
+ "type": "numeric string",
16822
+ "GoogleBigQueryType": "numeric"
16823
+ },
16824
+ "instant_experience_outbound_clicks": {
16825
+ "description": "instant_experience_outbound_clicks",
16826
+ "type": "list<AdsActionStats>"
16827
+ },
16828
+ "interactive_component_tap": {
16829
+ "description": "interactive_component_tap",
16830
+ "type": "list<AdsActionStats>"
16831
+ },
16832
+ "marketing_messages_delivery_rate": {
16833
+ "description": "The number of messages delivered divided by the number of messages sent. Some messages may not be delivered, such as when a customer's device is out of service. This metric doesn't include messages sent to Europe and Japan.",
16834
+ "type": "numeric string",
16835
+ "GoogleBigQueryType": "numeric"
16836
+ },
16837
+ "mobile_app_purchase_roas": {
16838
+ "description": "The total return on ad spend (ROAS) from mobile app purchases. This is based on the value that you assigned when you set up the app event.",
16839
+ "type": "list<AdsActionStats>"
16840
+ },
16841
+ "objective": {
16842
+ "description": "The objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.",
16843
+ "type": "string"
16844
+ },
16845
+ "optimization_goal": {
16846
+ "description": "The optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.",
16847
+ "type": "string"
16848
+ },
16849
+ "outbound_clicks": {
16850
+ "description": "The number of clicks on links that take people off Facebook-owned properties.",
16851
+ "type": "list<AdsActionStats>"
16852
+ },
16853
+ "outbound_clicks_ctr": {
16854
+ "description": "The percentage of times people saw your ad and performed an outbound click.",
16855
+ "type": "list<AdsActionStats>"
16856
+ },
16857
+ "purchase_roas": {
16858
+ "description": "The total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.",
16859
+ "type": "list<AdsActionStats>"
16860
+ },
16861
+ "qualifying_question_qualify_answer_rate": {
16862
+ "description": "qualifying_question_qualify_answer_rate",
16863
+ "type": "numeric string",
16864
+ "GoogleBigQueryType": "numeric"
16865
+ },
16866
+ "reach": {
16867
+ "description": "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. This metric is estimated.",
16868
+ "type": "numeric string",
16869
+ "GoogleBigQueryType": "numeric"
16870
+ },
16871
+ "shops_assisted_purchases": {
16872
+ "description": "shops_assisted_purchases",
16873
+ "type": "string"
16874
+ },
16875
+ "social_spend": {
16876
+ "description": "The total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).",
16877
+ "type": "numeric string",
16878
+ "GoogleBigQueryType": "numeric"
16879
+ },
16880
+ "spend": {
16881
+ "description": "The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.",
16882
+ "type": "numeric string",
16883
+ "GoogleSheetsFormat": "$#,##0.00",
16884
+ "GoogleBigQueryType": "numeric"
16885
+ },
16886
+ "updated_time": {
16887
+ "description": "updated_time",
16888
+ "type": "string"
16889
+ },
16890
+ "video_30_sec_watched_actions": {
16891
+ "description": "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. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.",
16892
+ "type": "list<AdsActionStats>"
16893
+ },
16894
+ "video_avg_time_watched_actions": {
16895
+ "description": "The average time a video was played, including any time spent replaying the video for a single impression.",
16896
+ "type": "list<AdsActionStats>"
16897
+ },
16898
+ "video_continuous_2_sec_watched_actions": {
16899
+ "description": "video_continuous_2_sec_watched_actions",
16900
+ "type": "list<AdsActionStats>"
16901
+ },
16902
+ "video_p100_watched_actions": {
16903
+ "description": "The number of times your video was played at 100% of its length, including plays that skipped to this point.",
16904
+ "type": "list<AdsActionStats>"
16905
+ },
16906
+ "video_p25_watched_actions": {
16907
+ "description": "The number of times your video was played at 25% of its length, including plays that skipped to this point.",
16908
+ "type": "list<AdsActionStats>"
16909
+ },
16910
+ "video_p50_watched_actions": {
16911
+ "description": "The number of times your video was played at 50% of its length, including plays that skipped to this point.",
16912
+ "type": "list<AdsActionStats>"
16913
+ },
16914
+ "video_p75_watched_actions": {
16915
+ "description": "The number of times your video was played at 75% of its length, including plays that skipped to this point.",
16916
+ "type": "list<AdsActionStats>"
16917
+ },
16918
+ "video_p95_watched_actions": {
16919
+ "description": "The number of times your video was played at 95% of its length, including plays that skipped to this point.",
16920
+ "type": "list<AdsActionStats>"
16921
+ },
16922
+ "video_play_actions": {
16923
+ "description": "The number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.",
16924
+ "type": "list<AdsActionStats>"
16925
+ },
16926
+ "video_play_curve_actions": {
16927
+ "description": "A video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges [15 to 20), [20 to 25), and [25 to 30). Entries 18 to 20 represent second ranges [30 to 40), [40 to 50), and [50 to 60). Entry 21 represents plays over 60 seconds.",
16928
+ "type": "list<AdsHistogramStats>"
16929
+ },
16930
+ "video_play_retention_0_to_15s_actions": {
16931
+ "description": "video_play_retention_0_to_15s_actions",
16932
+ "type": "list<AdsHistogramStats>"
16933
+ },
16934
+ "video_play_retention_20_to_60s_actions": {
16935
+ "description": "video_play_retention_20_to_60s_actions",
16936
+ "type": "list<AdsHistogramStats>"
16937
+ },
16938
+ "video_play_retention_graph_actions": {
16939
+ "description": "video_play_retention_graph_actions",
16940
+ "type": "list<AdsHistogramStats>"
16941
+ },
16942
+ "video_time_watched_actions": {
16943
+ "description": "video_time_watched_actions",
16944
+ "type": "list<AdsActionStats>"
16945
+ },
16946
+ "website_ctr": {
16947
+ "description": "The percentage of times people saw your ad and performed a link click.",
16948
+ "type": "list<AdsActionStats>"
16949
+ },
16950
+ "website_purchase_roas": {
16951
+ "description": "The total return on ad spend (ROAS) from website purchases. This is based on the value of all conversions recorded by the Facebook pixel on your website and attributed to your ads.",
16952
+ "type": "list<AdsActionStats>"
16953
+ },
16954
+ "wish_bid": {
16955
+ "description": "wish_bid",
16956
+ "type": "numeric string",
16957
+ "GoogleBigQueryType": "numeric"
16958
+ }
16959
+ };
16960
+ var adAccountInsightsFieldsByRegion = {
16961
+ "account_currency": {
16962
+ "description": "Currency that is used by your ad account.",
16963
+ "type": "string"
16964
+ },
16965
+ "account_id": {
16966
+ "description": "The ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.",
16967
+ "type": "numeric string",
16968
+ "GoogleSheetsFormat": "@"
16969
+ },
16970
+ "account_name": {
16971
+ "description": "The name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.",
16972
+ "type": "string"
16973
+ },
16974
+ "action_values": {
16975
+ "description": "The total value of all conversions attributed to your ads.",
16976
+ "type": "list<AdsActionStats>"
16977
+ },
16978
+ "actions": {
16979
+ "description": "The total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.",
16980
+ "type": "list<AdsActionStats>"
16981
+ },
16982
+ "ad_click_actions": {
16983
+ "description": "ad_click_actions",
16984
+ "type": "list<AdsActionStats>"
16985
+ },
16986
+ "ad_id": {
16987
+ "description": "The unique ID of the ad you're viewing in reporting.",
16988
+ "type": "numeric string",
16989
+ "GoogleSheetsFormat": "@"
16990
+ },
16991
+ "ad_impression_actions": {
16992
+ "description": "ad_impression_actions",
16993
+ "type": "list<AdsActionStats>"
16994
+ },
16995
+ "ad_name": {
16996
+ "description": "The name of the ad you're viewing in reporting.",
16997
+ "type": "string"
16998
+ },
16999
+ "adset_id": {
17000
+ "description": "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.",
17001
+ "type": "numeric string",
17002
+ "GoogleSheetsFormat": "@"
17003
+ },
17004
+ "adset_name": {
17005
+ "description": "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.",
17006
+ "type": "string"
17007
+ },
17008
+ "attribution_setting": {
17009
+ "description": "The default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.",
17010
+ "type": "string"
17011
+ },
17012
+ "auction_bid": {
17013
+ "description": "auction_bid",
17014
+ "type": "numeric string",
17015
+ "GoogleBigQueryType": "numeric"
17016
+ },
17017
+ "auction_competitiveness": {
17018
+ "description": "auction_competitiveness",
17019
+ "type": "numeric string",
17020
+ "GoogleBigQueryType": "numeric"
17021
+ },
17022
+ "auction_max_competitor_bid": {
17023
+ "description": "auction_max_competitor_bid",
17024
+ "type": "numeric string",
17025
+ "GoogleBigQueryType": "numeric"
17026
+ },
17027
+ "buying_type": {
17028
+ "description": "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. This field is currently only visible at the campaign level.",
17029
+ "type": "string"
17030
+ },
17031
+ "campaign_id": {
17032
+ "description": "The unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.",
17033
+ "type": "numeric string",
17034
+ "GoogleSheetsFormat": "@"
17035
+ },
17036
+ "campaign_name": {
17037
+ "description": "The name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.",
17038
+ "type": "string"
17039
+ },
17040
+ "canvas_avg_view_percent": {
17041
+ "description": "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. It may include a series of interactive or multimedia components, including video, images product catalog and more.",
17042
+ "type": "numeric string",
17043
+ "GoogleBigQueryType": "numeric"
17044
+ },
17045
+ "canvas_avg_view_time": {
17046
+ "description": "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. It may include a series of interactive or multimedia components, including video, images product catalog and more.",
17047
+ "type": "numeric string",
17048
+ "GoogleBigQueryType": "numeric"
17049
+ },
17050
+ "catalog_segment_actions": {
17051
+ "description": "The number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.",
17052
+ "type": "list<AdsActionStats>"
17053
+ },
17054
+ "catalog_segment_value": {
17055
+ "description": "The total value of all conversions from your catalog segment attributed to your ads.",
17056
+ "type": "list<AdsActionStats>"
17057
+ },
17058
+ "catalog_segment_value_mobile_purchase_roas": {
17059
+ "description": "The total return on ad spend (ROAS) from mobile app purchases for your catalog segment.",
17060
+ "type": "list<AdsActionStats>"
17061
+ },
17062
+ "catalog_segment_value_omni_purchase_roas": {
17063
+ "description": "The total return on ad spend (ROAS) from all purchases for your catalog segment.",
17064
+ "type": "list<AdsActionStats>"
17065
+ },
17066
+ "catalog_segment_value_website_purchase_roas": {
17067
+ "description": "The total return on ad spend (ROAS) from website purchases for your catalog segment.",
17068
+ "type": "list<AdsActionStats>"
17069
+ },
17070
+ "clicks": {
17071
+ "description": "The number of clicks on your ads.",
17072
+ "type": "numeric string",
17073
+ "GoogleBigQueryType": "numeric"
17074
+ },
17075
+ "conversion_values": {
17076
+ "description": "conversion_values",
17077
+ "type": "list<AdsActionStats>"
17078
+ },
17079
+ "conversions": {
17080
+ "description": "conversions",
17081
+ "type": "list<AdsActionStats>"
17082
+ },
17083
+ "converted_product_quantity": {
17084
+ "description": "The number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.",
17085
+ "type": "list<AdsActionStats>"
17086
+ },
17087
+ "converted_product_value": {
17088
+ "description": "The value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.",
17089
+ "type": "list<AdsActionStats>"
17090
+ },
17091
+ "cost_per_15_sec_video_view": {
17092
+ "description": "cost_per_15_sec_video_view",
17093
+ "type": "list<AdsActionStats>"
17094
+ },
17095
+ "cost_per_2_sec_continuous_video_view": {
17096
+ "description": "cost_per_2_sec_continuous_video_view",
17097
+ "type": "list<AdsActionStats>"
17098
+ },
17099
+ "cost_per_action_type": {
17100
+ "description": "The average cost of a relevant action.",
17101
+ "type": "list<AdsActionStats>"
17102
+ },
17103
+ "cost_per_ad_click": {
17104
+ "description": "cost_per_ad_click",
17105
+ "type": "list<AdsActionStats>"
17106
+ },
17107
+ "cost_per_conversion": {
17108
+ "description": "cost_per_conversion",
17109
+ "type": "list<AdsActionStats>"
17110
+ },
17111
+ "cost_per_dda_countby_convs": {
17112
+ "description": "cost_per_dda_countby_convs",
17113
+ "type": "numeric string",
17114
+ "GoogleBigQueryType": "numeric"
17115
+ },
17116
+ "cost_per_inline_link_click": {
17117
+ "description": "The average cost of each inline link click.",
17118
+ "type": "numeric string",
17119
+ "GoogleBigQueryType": "numeric"
17120
+ },
17121
+ "cost_per_inline_post_engagement": {
17122
+ "description": "The average cost of each inline post engagement.",
17123
+ "type": "numeric string",
17124
+ "GoogleBigQueryType": "numeric"
17125
+ },
17126
+ "cost_per_one_thousand_ad_impression": {
17127
+ "description": "cost_per_one_thousand_ad_impression",
17128
+ "type": "list<AdsActionStats>"
17129
+ },
17130
+ "cost_per_outbound_click": {
17131
+ "description": "The average cost for each outbound click.",
17132
+ "type": "list<AdsActionStats>"
17133
+ },
17134
+ "cost_per_thruplay": {
17135
+ "description": "The average cost for each ThruPlay. This metric is in development.",
17136
+ "type": "list<AdsActionStats>"
17137
+ },
17138
+ "cost_per_unique_action_type": {
17139
+ "description": "The average cost of each unique action. This metric is estimated.",
17140
+ "type": "list<AdsActionStats>"
17141
+ },
17142
+ "cost_per_unique_click": {
17143
+ "description": "The average cost for each unique click (all). This metric is estimated.",
17144
+ "type": "numeric string",
17145
+ "GoogleBigQueryType": "numeric"
17146
+ },
17147
+ "cost_per_unique_conversion": {
17148
+ "description": "cost_per_unique_conversion",
17149
+ "type": "list<AdsActionStats>"
17150
+ },
17151
+ "cost_per_unique_inline_link_click": {
17152
+ "description": "The average cost of each unique inline link click. This metric is estimated.",
17153
+ "type": "numeric string",
17154
+ "GoogleBigQueryType": "numeric"
17155
+ },
17156
+ "cost_per_unique_outbound_click": {
17157
+ "description": "The average cost for each unique outbound click. This metric is estimated.",
17158
+ "type": "list<AdsActionStats>"
17159
+ },
17160
+ "cpc": {
17161
+ "description": "The average cost for each click (all).",
17162
+ "type": "numeric string",
17163
+ "GoogleBigQueryType": "numeric"
17164
+ },
17165
+ "cpm": {
17166
+ "description": "The average cost for 1,000 impressions.",
17167
+ "type": "numeric string",
17168
+ "GoogleBigQueryType": "numeric"
17169
+ },
17170
+ "cpp": {
17171
+ "description": "The average cost to reach 1,000 people. This metric is estimated.",
17172
+ "type": "numeric string",
17173
+ "GoogleBigQueryType": "numeric"
17174
+ },
17175
+ "created_time": {
17176
+ "description": "created_time",
17177
+ "type": "string"
17178
+ },
17179
+ "ctr": {
17180
+ "description": "The percentage of times people saw your ad and performed a click (all).",
17181
+ "type": "numeric string",
17182
+ "GoogleBigQueryType": "numeric"
17183
+ },
17184
+ "date_start": {
17185
+ "description": "The start date for your data. This is controlled by the date range you've selected for your reporting view.",
17186
+ "type": "string",
17187
+ "GoogleBigQueryType": "date",
17188
+ "GoogleBigQueryPartitioned": true
17189
+ },
17190
+ "date_stop": {
17191
+ "description": "The end date for your data. This is controlled by the date range you've selected for your reporting view.",
17192
+ "type": "string",
17193
+ "GoogleBigQueryType": "date"
17194
+ },
17195
+ "dda_countby_convs": {
17196
+ "description": "dda_countby_convs",
17197
+ "type": "numeric string",
17198
+ "GoogleBigQueryType": "numeric"
17199
+ },
17200
+ "dda_results": {
17201
+ "description": "dda_results",
17202
+ "type": "list<AdsInsightsDdaResult>"
17203
+ },
17204
+ "frequency": {
17205
+ "description": "The average number of times each person saw your ad. This metric is estimated.",
17206
+ "type": "numeric string",
17207
+ "GoogleBigQueryType": "numeric"
17208
+ },
17209
+ "full_view_impressions": {
17210
+ "description": "The number of Full Views on your Page's posts as a result of your ad.",
17211
+ "type": "numeric string",
17212
+ "GoogleBigQueryType": "numeric"
17213
+ },
17214
+ "full_view_reach": {
17215
+ "description": "The number of people who performed a Full View on your Page's post as a result of your ad.",
17216
+ "type": "numeric string",
17217
+ "GoogleBigQueryType": "numeric"
17218
+ },
17219
+ "impressions": {
17220
+ "description": "The number of times your ads were on screen.",
17221
+ "type": "numeric string",
17222
+ "GoogleBigQueryType": "numeric"
17223
+ },
17224
+ "inline_link_click_ctr": {
17225
+ "description": "The percentage of time people saw your ads and performed an inline link click.",
17226
+ "type": "numeric string",
17227
+ "GoogleBigQueryType": "numeric"
17228
+ },
17229
+ "inline_link_clicks": {
17230
+ "description": "The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties. Inline link clicks use a fixed 1-day-click attribution window.",
17231
+ "type": "numeric string",
17232
+ "GoogleBigQueryType": "numeric"
17233
+ },
17234
+ "inline_post_engagement": {
17235
+ "description": "The total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.",
17236
+ "type": "numeric string",
17237
+ "GoogleBigQueryType": "numeric"
17238
+ },
17239
+ "instagram_upcoming_event_reminders_set": {
17240
+ "description": "instagram_upcoming_event_reminders_set",
17241
+ "type": "numeric string",
17242
+ "GoogleBigQueryType": "numeric"
17243
+ },
17244
+ "instant_experience_clicks_to_open": {
17245
+ "description": "instant_experience_clicks_to_open",
17246
+ "type": "numeric string",
17247
+ "GoogleBigQueryType": "numeric"
17248
+ },
17249
+ "instant_experience_clicks_to_start": {
17250
+ "description": "instant_experience_clicks_to_start",
17251
+ "type": "numeric string",
17252
+ "GoogleBigQueryType": "numeric"
17253
+ },
17254
+ "instant_experience_outbound_clicks": {
17255
+ "description": "instant_experience_outbound_clicks",
17256
+ "type": "list<AdsActionStats>"
17257
+ },
17258
+ "interactive_component_tap": {
17259
+ "description": "interactive_component_tap",
17260
+ "type": "list<AdsActionStats>"
17261
+ },
17262
+ "marketing_messages_delivery_rate": {
17263
+ "description": "The number of messages delivered divided by the number of messages sent. Some messages may not be delivered, such as when a customer's device is out of service. This metric doesn't include messages sent to Europe and Japan.",
17264
+ "type": "numeric string",
17265
+ "GoogleBigQueryType": "numeric"
17266
+ },
17267
+ "mobile_app_purchase_roas": {
17268
+ "description": "The total return on ad spend (ROAS) from mobile app purchases. This is based on the value that you assigned when you set up the app event.",
17269
+ "type": "list<AdsActionStats>"
17270
+ },
17271
+ "objective": {
17272
+ "description": "The objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.",
17273
+ "type": "string"
17274
+ },
17275
+ "optimization_goal": {
17276
+ "description": "The optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.",
17277
+ "type": "string"
17278
+ },
17279
+ "outbound_clicks": {
17280
+ "description": "The number of clicks on links that take people off Facebook-owned properties.",
17281
+ "type": "list<AdsActionStats>"
17282
+ },
17283
+ "outbound_clicks_ctr": {
17284
+ "description": "The percentage of times people saw your ad and performed an outbound click.",
17285
+ "type": "list<AdsActionStats>"
17286
+ },
17287
+ "purchase_roas": {
17288
+ "description": "The total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.",
17289
+ "type": "list<AdsActionStats>"
17290
+ },
17291
+ "qualifying_question_qualify_answer_rate": {
17292
+ "description": "qualifying_question_qualify_answer_rate",
17293
+ "type": "numeric string",
17294
+ "GoogleBigQueryType": "numeric"
17295
+ },
17296
+ "reach": {
17297
+ "description": "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. This metric is estimated.",
17298
+ "type": "numeric string",
17299
+ "GoogleBigQueryType": "numeric"
17300
+ },
17301
+ "region": {
17302
+ "description": "The region where your ads were shown.",
17303
+ "type": "string"
17304
+ },
17305
+ "shops_assisted_purchases": {
17306
+ "description": "shops_assisted_purchases",
17307
+ "type": "string"
17308
+ },
17309
+ "social_spend": {
17310
+ "description": "The total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).",
17311
+ "type": "numeric string",
17312
+ "GoogleBigQueryType": "numeric"
17313
+ },
17314
+ "spend": {
17315
+ "description": "The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.",
17316
+ "type": "numeric string",
17317
+ "GoogleSheetsFormat": "$#,##0.00",
17318
+ "GoogleBigQueryType": "numeric"
17319
+ },
17320
+ "updated_time": {
17321
+ "description": "updated_time",
17322
+ "type": "string"
17323
+ },
17324
+ "video_30_sec_watched_actions": {
17325
+ "description": "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. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.",
17326
+ "type": "list<AdsActionStats>"
17327
+ },
17328
+ "video_avg_time_watched_actions": {
17329
+ "description": "The average time a video was played, including any time spent replaying the video for a single impression.",
17330
+ "type": "list<AdsActionStats>"
17331
+ },
17332
+ "video_continuous_2_sec_watched_actions": {
17333
+ "description": "video_continuous_2_sec_watched_actions",
17334
+ "type": "list<AdsActionStats>"
17335
+ },
17336
+ "video_p100_watched_actions": {
17337
+ "description": "The number of times your video was played at 100% of its length, including plays that skipped to this point.",
17338
+ "type": "list<AdsActionStats>"
17339
+ },
17340
+ "video_p25_watched_actions": {
17341
+ "description": "The number of times your video was played at 25% of its length, including plays that skipped to this point.",
17342
+ "type": "list<AdsActionStats>"
17343
+ },
17344
+ "video_p50_watched_actions": {
17345
+ "description": "The number of times your video was played at 50% of its length, including plays that skipped to this point.",
17346
+ "type": "list<AdsActionStats>"
17347
+ },
17348
+ "video_p75_watched_actions": {
17349
+ "description": "The number of times your video was played at 75% of its length, including plays that skipped to this point.",
17350
+ "type": "list<AdsActionStats>"
17351
+ },
17352
+ "video_p95_watched_actions": {
17353
+ "description": "The number of times your video was played at 95% of its length, including plays that skipped to this point.",
17354
+ "type": "list<AdsActionStats>"
17355
+ },
17356
+ "video_play_actions": {
17357
+ "description": "The number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.",
17358
+ "type": "list<AdsActionStats>"
17359
+ },
17360
+ "video_play_curve_actions": {
17361
+ "description": "A video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges [15 to 20), [20 to 25), and [25 to 30). Entries 18 to 20 represent second ranges [30 to 40), [40 to 50), and [50 to 60). Entry 21 represents plays over 60 seconds.",
17362
+ "type": "list<AdsHistogramStats>"
17363
+ },
17364
+ "video_play_retention_0_to_15s_actions": {
17365
+ "description": "video_play_retention_0_to_15s_actions",
17366
+ "type": "list<AdsHistogramStats>"
17367
+ },
17368
+ "video_play_retention_20_to_60s_actions": {
17369
+ "description": "video_play_retention_20_to_60s_actions",
17370
+ "type": "list<AdsHistogramStats>"
17371
+ },
17372
+ "video_play_retention_graph_actions": {
17373
+ "description": "video_play_retention_graph_actions",
17374
+ "type": "list<AdsHistogramStats>"
17375
+ },
17376
+ "video_time_watched_actions": {
17377
+ "description": "video_time_watched_actions",
17378
+ "type": "list<AdsActionStats>"
17379
+ },
17380
+ "website_ctr": {
17381
+ "description": "The percentage of times people saw your ad and performed a link click.",
17382
+ "type": "list<AdsActionStats>"
17383
+ },
17384
+ "website_purchase_roas": {
17385
+ "description": "The total return on ad spend (ROAS) from website purchases. This is based on the value of all conversions recorded by the Facebook pixel on your website and attributed to your ads.",
17386
+ "type": "list<AdsActionStats>"
17387
+ },
17388
+ "wish_bid": {
17389
+ "description": "wish_bid",
17390
+ "type": "numeric string",
17391
+ "GoogleBigQueryType": "numeric"
17392
+ }
17393
+ };
17394
+ var adAccountInsightsFieldsByPublisherPlatformAndPosition = {
17395
+ "account_currency": {
17396
+ "description": "Currency that is used by your ad account.",
17397
+ "type": "string"
17398
+ },
17399
+ "account_id": {
17400
+ "description": "The ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.",
17401
+ "type": "numeric string",
17402
+ "GoogleSheetsFormat": "@"
17403
+ },
17404
+ "account_name": {
17405
+ "description": "The name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.",
17406
+ "type": "string"
17407
+ },
17408
+ "action_values": {
17409
+ "description": "The total value of all conversions attributed to your ads.",
17410
+ "type": "list<AdsActionStats>"
17411
+ },
17412
+ "actions": {
17413
+ "description": "The total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.",
17414
+ "type": "list<AdsActionStats>"
17415
+ },
17416
+ "ad_click_actions": {
17417
+ "description": "ad_click_actions",
17418
+ "type": "list<AdsActionStats>"
17419
+ },
17420
+ "ad_id": {
17421
+ "description": "The unique ID of the ad you're viewing in reporting.",
17422
+ "type": "numeric string",
17423
+ "GoogleSheetsFormat": "@"
17424
+ },
17425
+ "ad_impression_actions": {
17426
+ "description": "ad_impression_actions",
17427
+ "type": "list<AdsActionStats>"
17428
+ },
17429
+ "ad_name": {
17430
+ "description": "The name of the ad you're viewing in reporting.",
17431
+ "type": "string"
17432
+ },
17433
+ "adset_id": {
17434
+ "description": "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.",
17435
+ "type": "numeric string",
17436
+ "GoogleSheetsFormat": "@"
17437
+ },
17438
+ "adset_name": {
17439
+ "description": "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.",
17440
+ "type": "string"
17441
+ },
17442
+ "attribution_setting": {
17443
+ "description": "The default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.",
17444
+ "type": "string"
17445
+ },
17446
+ "auction_bid": {
17447
+ "description": "auction_bid",
17448
+ "type": "numeric string",
17449
+ "GoogleBigQueryType": "numeric"
17450
+ },
17451
+ "auction_competitiveness": {
17452
+ "description": "auction_competitiveness",
17453
+ "type": "numeric string",
17454
+ "GoogleBigQueryType": "numeric"
17455
+ },
17456
+ "auction_max_competitor_bid": {
17457
+ "description": "auction_max_competitor_bid",
17458
+ "type": "numeric string",
17459
+ "GoogleBigQueryType": "numeric"
17460
+ },
17461
+ "buying_type": {
17462
+ "description": "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. This field is currently only visible at the campaign level.",
17463
+ "type": "string"
17464
+ },
17465
+ "campaign_id": {
17466
+ "description": "The unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.",
17467
+ "type": "numeric string",
17468
+ "GoogleSheetsFormat": "@"
17469
+ },
17470
+ "campaign_name": {
17471
+ "description": "The name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.",
17472
+ "type": "string"
17473
+ },
17474
+ "canvas_avg_view_percent": {
17475
+ "description": "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. It may include a series of interactive or multimedia components, including video, images product catalog and more.",
17476
+ "type": "numeric string",
17477
+ "GoogleBigQueryType": "numeric"
17478
+ },
17479
+ "canvas_avg_view_time": {
17480
+ "description": "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. It may include a series of interactive or multimedia components, including video, images product catalog and more.",
17481
+ "type": "numeric string",
17482
+ "GoogleBigQueryType": "numeric"
17483
+ },
17484
+ "catalog_segment_actions": {
17485
+ "description": "The number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.",
17486
+ "type": "list<AdsActionStats>"
17487
+ },
17488
+ "catalog_segment_value": {
17489
+ "description": "The total value of all conversions from your catalog segment attributed to your ads.",
17490
+ "type": "list<AdsActionStats>"
17491
+ },
17492
+ "catalog_segment_value_mobile_purchase_roas": {
17493
+ "description": "The total return on ad spend (ROAS) from mobile app purchases for your catalog segment.",
17494
+ "type": "list<AdsActionStats>"
17495
+ },
17496
+ "catalog_segment_value_omni_purchase_roas": {
17497
+ "description": "The total return on ad spend (ROAS) from all purchases for your catalog segment.",
17498
+ "type": "list<AdsActionStats>"
17499
+ },
17500
+ "catalog_segment_value_website_purchase_roas": {
17501
+ "description": "The total return on ad spend (ROAS) from website purchases for your catalog segment.",
17502
+ "type": "list<AdsActionStats>"
17503
+ },
17504
+ "clicks": {
17505
+ "description": "The number of clicks on your ads.",
17506
+ "type": "numeric string",
17507
+ "GoogleBigQueryType": "numeric"
17508
+ },
17509
+ "conversion_values": {
17510
+ "description": "conversion_values",
17511
+ "type": "list<AdsActionStats>"
17512
+ },
17513
+ "conversions": {
17514
+ "description": "conversions",
17515
+ "type": "list<AdsActionStats>"
17516
+ },
17517
+ "converted_product_quantity": {
17518
+ "description": "The number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.",
17519
+ "type": "list<AdsActionStats>"
17520
+ },
17521
+ "converted_product_value": {
17522
+ "description": "The value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.",
17523
+ "type": "list<AdsActionStats>"
17524
+ },
17525
+ "cost_per_15_sec_video_view": {
17526
+ "description": "cost_per_15_sec_video_view",
17527
+ "type": "list<AdsActionStats>"
17528
+ },
17529
+ "cost_per_2_sec_continuous_video_view": {
17530
+ "description": "cost_per_2_sec_continuous_video_view",
17531
+ "type": "list<AdsActionStats>"
17532
+ },
17533
+ "cost_per_action_type": {
17534
+ "description": "The average cost of a relevant action.",
17535
+ "type": "list<AdsActionStats>"
17536
+ },
17537
+ "cost_per_ad_click": {
17538
+ "description": "cost_per_ad_click",
17539
+ "type": "list<AdsActionStats>"
17540
+ },
17541
+ "cost_per_conversion": {
17542
+ "description": "cost_per_conversion",
17543
+ "type": "list<AdsActionStats>"
17544
+ },
17545
+ "cost_per_dda_countby_convs": {
17546
+ "description": "cost_per_dda_countby_convs",
17547
+ "type": "numeric string",
17548
+ "GoogleBigQueryType": "numeric"
17549
+ },
17550
+ "cost_per_inline_link_click": {
17551
+ "description": "The average cost of each inline link click.",
17552
+ "type": "numeric string",
17553
+ "GoogleBigQueryType": "numeric"
17554
+ },
17555
+ "cost_per_inline_post_engagement": {
17556
+ "description": "The average cost of each inline post engagement.",
17557
+ "type": "numeric string",
17558
+ "GoogleBigQueryType": "numeric"
17559
+ },
17560
+ "cost_per_one_thousand_ad_impression": {
17561
+ "description": "cost_per_one_thousand_ad_impression",
17562
+ "type": "list<AdsActionStats>"
17563
+ },
17564
+ "cost_per_outbound_click": {
17565
+ "description": "The average cost for each outbound click.",
17566
+ "type": "list<AdsActionStats>"
17567
+ },
17568
+ "cost_per_thruplay": {
17569
+ "description": "The average cost for each ThruPlay. This metric is in development.",
17570
+ "type": "list<AdsActionStats>"
17571
+ },
17572
+ "cost_per_unique_action_type": {
17573
+ "description": "The average cost of each unique action. This metric is estimated.",
17574
+ "type": "list<AdsActionStats>"
17575
+ },
17576
+ "cost_per_unique_click": {
17577
+ "description": "The average cost for each unique click (all). This metric is estimated.",
17578
+ "type": "numeric string",
17579
+ "GoogleBigQueryType": "numeric"
17580
+ },
17581
+ "cost_per_unique_conversion": {
17582
+ "description": "cost_per_unique_conversion",
17583
+ "type": "list<AdsActionStats>"
17584
+ },
17585
+ "cost_per_unique_inline_link_click": {
17586
+ "description": "The average cost of each unique inline link click. This metric is estimated.",
17587
+ "type": "numeric string",
17588
+ "GoogleBigQueryType": "numeric"
17589
+ },
17590
+ "cost_per_unique_outbound_click": {
17591
+ "description": "The average cost for each unique outbound click. This metric is estimated.",
17592
+ "type": "list<AdsActionStats>"
17593
+ },
17594
+ "cpc": {
17595
+ "description": "The average cost for each click (all).",
17596
+ "type": "numeric string",
17597
+ "GoogleBigQueryType": "numeric"
17598
+ },
17599
+ "cpm": {
17600
+ "description": "The average cost for 1,000 impressions.",
17601
+ "type": "numeric string",
17602
+ "GoogleBigQueryType": "numeric"
17603
+ },
17604
+ "cpp": {
17605
+ "description": "The average cost to reach 1,000 people. This metric is estimated.",
17606
+ "type": "numeric string",
17607
+ "GoogleBigQueryType": "numeric"
17608
+ },
17609
+ "created_time": {
17610
+ "description": "created_time",
17611
+ "type": "string"
17612
+ },
17613
+ "ctr": {
17614
+ "description": "The percentage of times people saw your ad and performed a click (all).",
17615
+ "type": "numeric string",
17616
+ "GoogleBigQueryType": "numeric"
17617
+ },
17618
+ "date_start": {
17619
+ "description": "The start date for your data. This is controlled by the date range you've selected for your reporting view.",
17620
+ "type": "string",
17621
+ "GoogleBigQueryType": "date",
17622
+ "GoogleBigQueryPartitioned": true
17623
+ },
17624
+ "date_stop": {
17625
+ "description": "The end date for your data. This is controlled by the date range you've selected for your reporting view.",
17626
+ "type": "string",
17627
+ "GoogleBigQueryType": "date"
17628
+ },
17629
+ "dda_countby_convs": {
17630
+ "description": "dda_countby_convs",
17631
+ "type": "numeric string",
17632
+ "GoogleBigQueryType": "numeric"
17633
+ },
17634
+ "dda_results": {
17635
+ "description": "dda_results",
17636
+ "type": "list<AdsInsightsDdaResult>"
17637
+ },
17638
+ "frequency": {
17639
+ "description": "The average number of times each person saw your ad. This metric is estimated.",
17640
+ "type": "numeric string",
17641
+ "GoogleBigQueryType": "numeric"
17642
+ },
17643
+ "full_view_impressions": {
17644
+ "description": "The number of Full Views on your Page's posts as a result of your ad.",
17645
+ "type": "numeric string",
17646
+ "GoogleBigQueryType": "numeric"
17647
+ },
17648
+ "full_view_reach": {
17649
+ "description": "The number of people who performed a Full View on your Page's post as a result of your ad.",
17650
+ "type": "numeric string",
17651
+ "GoogleBigQueryType": "numeric"
17652
+ },
17653
+ "impressions": {
17654
+ "description": "The number of times your ads were on screen.",
17655
+ "type": "numeric string",
17656
+ "GoogleBigQueryType": "numeric"
17657
+ },
17658
+ "inline_link_click_ctr": {
17659
+ "description": "The percentage of time people saw your ads and performed an inline link click.",
17660
+ "type": "numeric string",
17661
+ "GoogleBigQueryType": "numeric"
17662
+ },
17663
+ "inline_link_clicks": {
17664
+ "description": "The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties. Inline link clicks use a fixed 1-day-click attribution window.",
17665
+ "type": "numeric string",
17666
+ "GoogleBigQueryType": "numeric"
17667
+ },
17668
+ "inline_post_engagement": {
17669
+ "description": "The total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.",
17670
+ "type": "numeric string",
17671
+ "GoogleBigQueryType": "numeric"
17672
+ },
17673
+ "instagram_upcoming_event_reminders_set": {
17674
+ "description": "instagram_upcoming_event_reminders_set",
17675
+ "type": "numeric string",
17676
+ "GoogleBigQueryType": "numeric"
17677
+ },
17678
+ "instant_experience_clicks_to_open": {
17679
+ "description": "instant_experience_clicks_to_open",
17680
+ "type": "numeric string",
17681
+ "GoogleBigQueryType": "numeric"
17682
+ },
17683
+ "instant_experience_clicks_to_start": {
17684
+ "description": "instant_experience_clicks_to_start",
17685
+ "type": "numeric string",
17686
+ "GoogleBigQueryType": "numeric"
17687
+ },
17688
+ "instant_experience_outbound_clicks": {
17689
+ "description": "instant_experience_outbound_clicks",
17690
+ "type": "list<AdsActionStats>"
17691
+ },
17692
+ "interactive_component_tap": {
17693
+ "description": "interactive_component_tap",
17694
+ "type": "list<AdsActionStats>"
17695
+ },
17696
+ "marketing_messages_delivery_rate": {
17697
+ "description": "The number of messages delivered divided by the number of messages sent. Some messages may not be delivered, such as when a customer's device is out of service. This metric doesn't include messages sent to Europe and Japan.",
17698
+ "type": "numeric string",
17699
+ "GoogleBigQueryType": "numeric"
17700
+ },
17701
+ "mobile_app_purchase_roas": {
17702
+ "description": "The total return on ad spend (ROAS) from mobile app purchases. This is based on the value that you assigned when you set up the app event.",
17703
+ "type": "list<AdsActionStats>"
17704
+ },
17705
+ "objective": {
17706
+ "description": "The objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.",
17707
+ "type": "string"
17708
+ },
17709
+ "optimization_goal": {
17710
+ "description": "The optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.",
17711
+ "type": "string"
17712
+ },
17713
+ "outbound_clicks": {
17714
+ "description": "The number of clicks on links that take people off Facebook-owned properties.",
17715
+ "type": "list<AdsActionStats>"
17716
+ },
17717
+ "outbound_clicks_ctr": {
17718
+ "description": "The percentage of times people saw your ad and performed an outbound click.",
17719
+ "type": "list<AdsActionStats>"
17720
+ },
17721
+ "platform_position": {
17722
+ "description": "platform_position",
17723
+ "type": "string"
17724
+ },
17725
+ "publisher_platform": {
17726
+ "description": "Which platform your ad was shown, for example on Facebook, Instagram, or Audience Network.",
17727
+ "type": "string"
17728
+ },
17729
+ "purchase_roas": {
17730
+ "description": "The total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.",
17731
+ "type": "list<AdsActionStats>"
17732
+ },
17733
+ "qualifying_question_qualify_answer_rate": {
17734
+ "description": "qualifying_question_qualify_answer_rate",
17735
+ "type": "numeric string",
17736
+ "GoogleBigQueryType": "numeric"
17737
+ },
17738
+ "reach": {
17739
+ "description": "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. This metric is estimated.",
17740
+ "type": "numeric string",
17741
+ "GoogleBigQueryType": "numeric"
17742
+ },
17743
+ "shops_assisted_purchases": {
17744
+ "description": "shops_assisted_purchases",
17745
+ "type": "string"
17746
+ },
17747
+ "social_spend": {
17748
+ "description": "The total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).",
17749
+ "type": "numeric string",
17750
+ "GoogleBigQueryType": "numeric"
17751
+ },
17752
+ "spend": {
17753
+ "description": "The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.",
17754
+ "type": "numeric string",
17755
+ "GoogleSheetsFormat": "$#,##0.00",
17756
+ "GoogleBigQueryType": "numeric"
17757
+ },
17758
+ "updated_time": {
17759
+ "description": "updated_time",
17760
+ "type": "string"
17761
+ },
17762
+ "video_30_sec_watched_actions": {
17763
+ "description": "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. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.",
17764
+ "type": "list<AdsActionStats>"
17765
+ },
17766
+ "video_avg_time_watched_actions": {
17767
+ "description": "The average time a video was played, including any time spent replaying the video for a single impression.",
17768
+ "type": "list<AdsActionStats>"
17769
+ },
17770
+ "video_continuous_2_sec_watched_actions": {
17771
+ "description": "video_continuous_2_sec_watched_actions",
17772
+ "type": "list<AdsActionStats>"
17773
+ },
17774
+ "video_p100_watched_actions": {
17775
+ "description": "The number of times your video was played at 100% of its length, including plays that skipped to this point.",
17776
+ "type": "list<AdsActionStats>"
17777
+ },
17778
+ "video_p25_watched_actions": {
17779
+ "description": "The number of times your video was played at 25% of its length, including plays that skipped to this point.",
17780
+ "type": "list<AdsActionStats>"
17781
+ },
17782
+ "video_p50_watched_actions": {
17783
+ "description": "The number of times your video was played at 50% of its length, including plays that skipped to this point.",
17784
+ "type": "list<AdsActionStats>"
17785
+ },
17786
+ "video_p75_watched_actions": {
17787
+ "description": "The number of times your video was played at 75% of its length, including plays that skipped to this point.",
17788
+ "type": "list<AdsActionStats>"
17789
+ },
17790
+ "video_p95_watched_actions": {
17791
+ "description": "The number of times your video was played at 95% of its length, including plays that skipped to this point.",
17792
+ "type": "list<AdsActionStats>"
17793
+ },
17794
+ "video_play_actions": {
17795
+ "description": "The number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.",
17796
+ "type": "list<AdsActionStats>"
17797
+ },
17798
+ "video_play_curve_actions": {
17799
+ "description": "A video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges [15 to 20), [20 to 25), and [25 to 30). Entries 18 to 20 represent second ranges [30 to 40), [40 to 50), and [50 to 60). Entry 21 represents plays over 60 seconds.",
17800
+ "type": "list<AdsHistogramStats>"
17801
+ },
17802
+ "video_play_retention_0_to_15s_actions": {
17803
+ "description": "video_play_retention_0_to_15s_actions",
17804
+ "type": "list<AdsHistogramStats>"
17805
+ },
17806
+ "video_play_retention_20_to_60s_actions": {
17807
+ "description": "video_play_retention_20_to_60s_actions",
17808
+ "type": "list<AdsHistogramStats>"
17809
+ },
17810
+ "video_play_retention_graph_actions": {
17811
+ "description": "video_play_retention_graph_actions",
17812
+ "type": "list<AdsHistogramStats>"
17813
+ },
17814
+ "video_time_watched_actions": {
17815
+ "description": "video_time_watched_actions",
17816
+ "type": "list<AdsActionStats>"
17817
+ },
17818
+ "website_ctr": {
17819
+ "description": "The percentage of times people saw your ad and performed a link click.",
17820
+ "type": "list<AdsActionStats>"
17821
+ },
17822
+ "website_purchase_roas": {
17823
+ "description": "The total return on ad spend (ROAS) from website purchases. This is based on the value of all conversions recorded by the Facebook pixel on your website and attributed to your ads.",
17824
+ "type": "list<AdsActionStats>"
17825
+ },
17826
+ "wish_bid": {
17827
+ "description": "wish_bid",
17828
+ "type": "numeric string",
17829
+ "GoogleBigQueryType": "numeric"
17830
+ }
17831
+ };
17832
+ var adAccountInsightsFieldsByProductId = {
17833
+ "account_currency": {
17834
+ "description": "Currency that is used by your ad account.",
17835
+ "type": "string"
17836
+ },
17837
+ "account_id": {
17838
+ "description": "The ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.",
17839
+ "type": "numeric string",
17840
+ "GoogleSheetsFormat": "@"
17841
+ },
17842
+ "account_name": {
17843
+ "description": "The name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.",
17844
+ "type": "string"
17845
+ },
17846
+ "action_values": {
17847
+ "description": "The total value of all conversions attributed to your ads.",
17848
+ "type": "list<AdsActionStats>"
17849
+ },
17850
+ "actions": {
17851
+ "description": "The total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.",
17852
+ "type": "list<AdsActionStats>"
17853
+ },
17854
+ "ad_click_actions": {
17855
+ "description": "ad_click_actions",
17856
+ "type": "list<AdsActionStats>"
17857
+ },
17858
+ "ad_id": {
17859
+ "description": "The unique ID of the ad you're viewing in reporting.",
17860
+ "type": "numeric string",
17861
+ "GoogleSheetsFormat": "@"
17862
+ },
17863
+ "ad_impression_actions": {
17864
+ "description": "ad_impression_actions",
17865
+ "type": "list<AdsActionStats>"
17866
+ },
17867
+ "ad_name": {
17868
+ "description": "The name of the ad you're viewing in reporting.",
17869
+ "type": "string"
17870
+ },
17871
+ "adset_id": {
17872
+ "description": "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.",
17873
+ "type": "numeric string",
17874
+ "GoogleSheetsFormat": "@"
17875
+ },
17876
+ "adset_name": {
17877
+ "description": "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.",
17878
+ "type": "string"
17879
+ },
17880
+ "attribution_setting": {
17881
+ "description": "The default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.",
17882
+ "type": "string"
17883
+ },
17884
+ "auction_bid": {
17885
+ "description": "auction_bid",
17886
+ "type": "numeric string",
17887
+ "GoogleBigQueryType": "numeric"
17888
+ },
17889
+ "auction_competitiveness": {
17890
+ "description": "auction_competitiveness",
17891
+ "type": "numeric string",
17892
+ "GoogleBigQueryType": "numeric"
17893
+ },
17894
+ "auction_max_competitor_bid": {
17895
+ "description": "auction_max_competitor_bid",
17896
+ "type": "numeric string",
17897
+ "GoogleBigQueryType": "numeric"
17898
+ },
17899
+ "buying_type": {
17900
+ "description": "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. This field is currently only visible at the campaign level.",
17901
+ "type": "string"
17902
+ },
17903
+ "campaign_id": {
17904
+ "description": "The unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.",
17905
+ "type": "numeric string",
17906
+ "GoogleSheetsFormat": "@"
17907
+ },
17908
+ "campaign_name": {
17909
+ "description": "The name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.",
17910
+ "type": "string"
17911
+ },
17912
+ "canvas_avg_view_percent": {
17913
+ "description": "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. It may include a series of interactive or multimedia components, including video, images product catalog and more.",
17914
+ "type": "numeric string",
17915
+ "GoogleBigQueryType": "numeric"
17916
+ },
17917
+ "canvas_avg_view_time": {
17918
+ "description": "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. It may include a series of interactive or multimedia components, including video, images product catalog and more.",
17919
+ "type": "numeric string",
17920
+ "GoogleBigQueryType": "numeric"
17921
+ },
17922
+ "catalog_segment_actions": {
17923
+ "description": "The number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.",
17924
+ "type": "list<AdsActionStats>"
17925
+ },
17926
+ "catalog_segment_value": {
17927
+ "description": "The total value of all conversions from your catalog segment attributed to your ads.",
17928
+ "type": "list<AdsActionStats>"
17929
+ },
17930
+ "catalog_segment_value_mobile_purchase_roas": {
17931
+ "description": "The total return on ad spend (ROAS) from mobile app purchases for your catalog segment.",
17932
+ "type": "list<AdsActionStats>"
17933
+ },
17934
+ "catalog_segment_value_omni_purchase_roas": {
17935
+ "description": "The total return on ad spend (ROAS) from all purchases for your catalog segment.",
17936
+ "type": "list<AdsActionStats>"
17937
+ },
17938
+ "catalog_segment_value_website_purchase_roas": {
17939
+ "description": "The total return on ad spend (ROAS) from website purchases for your catalog segment.",
17940
+ "type": "list<AdsActionStats>"
17941
+ },
17942
+ "clicks": {
17943
+ "description": "The number of clicks on your ads.",
17944
+ "type": "numeric string",
17945
+ "GoogleBigQueryType": "numeric"
17946
+ },
17947
+ "conversion_values": {
17948
+ "description": "conversion_values",
17949
+ "type": "list<AdsActionStats>"
17950
+ },
17951
+ "conversions": {
17952
+ "description": "conversions",
17953
+ "type": "list<AdsActionStats>"
17954
+ },
17955
+ "converted_product_quantity": {
17956
+ "description": "The number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.",
17957
+ "type": "list<AdsActionStats>"
17958
+ },
17959
+ "converted_product_value": {
17960
+ "description": "The value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.",
17961
+ "type": "list<AdsActionStats>"
17962
+ },
17963
+ "cost_per_15_sec_video_view": {
17964
+ "description": "cost_per_15_sec_video_view",
17965
+ "type": "list<AdsActionStats>"
17966
+ },
17967
+ "cost_per_2_sec_continuous_video_view": {
17968
+ "description": "cost_per_2_sec_continuous_video_view",
17969
+ "type": "list<AdsActionStats>"
17970
+ },
17971
+ "cost_per_action_type": {
17972
+ "description": "The average cost of a relevant action.",
17973
+ "type": "list<AdsActionStats>"
17974
+ },
17975
+ "cost_per_ad_click": {
17976
+ "description": "cost_per_ad_click",
17977
+ "type": "list<AdsActionStats>"
17978
+ },
17979
+ "cost_per_conversion": {
17980
+ "description": "cost_per_conversion",
17981
+ "type": "list<AdsActionStats>"
17982
+ },
17983
+ "cost_per_dda_countby_convs": {
17984
+ "description": "cost_per_dda_countby_convs",
17985
+ "type": "numeric string",
17986
+ "GoogleBigQueryType": "numeric"
17987
+ },
17988
+ "cost_per_inline_link_click": {
17989
+ "description": "The average cost of each inline link click.",
17990
+ "type": "numeric string",
17991
+ "GoogleBigQueryType": "numeric"
17992
+ },
17993
+ "cost_per_inline_post_engagement": {
17994
+ "description": "The average cost of each inline post engagement.",
17995
+ "type": "numeric string",
17996
+ "GoogleBigQueryType": "numeric"
17997
+ },
17998
+ "cost_per_one_thousand_ad_impression": {
17999
+ "description": "cost_per_one_thousand_ad_impression",
18000
+ "type": "list<AdsActionStats>"
18001
+ },
18002
+ "cost_per_outbound_click": {
18003
+ "description": "The average cost for each outbound click.",
18004
+ "type": "list<AdsActionStats>"
18005
+ },
18006
+ "cost_per_thruplay": {
18007
+ "description": "The average cost for each ThruPlay. This metric is in development.",
18008
+ "type": "list<AdsActionStats>"
18009
+ },
18010
+ "cost_per_unique_action_type": {
18011
+ "description": "The average cost of each unique action. This metric is estimated.",
18012
+ "type": "list<AdsActionStats>"
18013
+ },
18014
+ "cost_per_unique_click": {
18015
+ "description": "The average cost for each unique click (all). This metric is estimated.",
18016
+ "type": "numeric string",
18017
+ "GoogleBigQueryType": "numeric"
18018
+ },
18019
+ "cost_per_unique_conversion": {
18020
+ "description": "cost_per_unique_conversion",
18021
+ "type": "list<AdsActionStats>"
18022
+ },
18023
+ "cost_per_unique_inline_link_click": {
18024
+ "description": "The average cost of each unique inline link click. This metric is estimated.",
18025
+ "type": "numeric string",
18026
+ "GoogleBigQueryType": "numeric"
18027
+ },
18028
+ "cost_per_unique_outbound_click": {
18029
+ "description": "The average cost for each unique outbound click. This metric is estimated.",
18030
+ "type": "list<AdsActionStats>"
18031
+ },
18032
+ "cpc": {
18033
+ "description": "The average cost for each click (all).",
18034
+ "type": "numeric string",
18035
+ "GoogleBigQueryType": "numeric"
18036
+ },
18037
+ "cpm": {
18038
+ "description": "The average cost for 1,000 impressions.",
18039
+ "type": "numeric string",
18040
+ "GoogleBigQueryType": "numeric"
18041
+ },
18042
+ "cpp": {
18043
+ "description": "The average cost to reach 1,000 people. This metric is estimated.",
18044
+ "type": "numeric string",
18045
+ "GoogleBigQueryType": "numeric"
18046
+ },
18047
+ "created_time": {
18048
+ "description": "created_time",
18049
+ "type": "string"
18050
+ },
18051
+ "ctr": {
18052
+ "description": "The percentage of times people saw your ad and performed a click (all).",
18053
+ "type": "numeric string",
18054
+ "GoogleBigQueryType": "numeric"
18055
+ },
18056
+ "date_start": {
18057
+ "description": "The start date for your data. This is controlled by the date range you've selected for your reporting view.",
18058
+ "type": "string",
18059
+ "GoogleBigQueryType": "date",
18060
+ "GoogleBigQueryPartitioned": true
18061
+ },
18062
+ "date_stop": {
18063
+ "description": "The end date for your data. This is controlled by the date range you've selected for your reporting view.",
18064
+ "type": "string",
18065
+ "GoogleBigQueryType": "date"
18066
+ },
18067
+ "dda_countby_convs": {
18068
+ "description": "dda_countby_convs",
18069
+ "type": "numeric string",
18070
+ "GoogleBigQueryType": "numeric"
18071
+ },
18072
+ "dda_results": {
18073
+ "description": "dda_results",
18074
+ "type": "list<AdsInsightsDdaResult>"
18075
+ },
18076
+ "frequency": {
18077
+ "description": "The average number of times each person saw your ad. This metric is estimated.",
18078
+ "type": "numeric string",
18079
+ "GoogleBigQueryType": "numeric"
18080
+ },
18081
+ "full_view_impressions": {
18082
+ "description": "The number of Full Views on your Page's posts as a result of your ad.",
18083
+ "type": "numeric string",
18084
+ "GoogleBigQueryType": "numeric"
18085
+ },
18086
+ "full_view_reach": {
18087
+ "description": "The number of people who performed a Full View on your Page's post as a result of your ad.",
18088
+ "type": "numeric string",
18089
+ "GoogleBigQueryType": "numeric"
18090
+ },
18091
+ "impressions": {
18092
+ "description": "The number of times your ads were on screen.",
18093
+ "type": "numeric string",
18094
+ "GoogleBigQueryType": "numeric"
18095
+ },
18096
+ "inline_link_click_ctr": {
18097
+ "description": "The percentage of time people saw your ads and performed an inline link click.",
18098
+ "type": "numeric string",
18099
+ "GoogleBigQueryType": "numeric"
18100
+ },
18101
+ "inline_link_clicks": {
18102
+ "description": "The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties. Inline link clicks use a fixed 1-day-click attribution window.",
18103
+ "type": "numeric string",
18104
+ "GoogleBigQueryType": "numeric"
18105
+ },
18106
+ "inline_post_engagement": {
18107
+ "description": "The total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.",
18108
+ "type": "numeric string",
18109
+ "GoogleBigQueryType": "numeric"
18110
+ },
18111
+ "instagram_upcoming_event_reminders_set": {
18112
+ "description": "instagram_upcoming_event_reminders_set",
18113
+ "type": "numeric string",
18114
+ "GoogleBigQueryType": "numeric"
18115
+ },
18116
+ "instant_experience_clicks_to_open": {
18117
+ "description": "instant_experience_clicks_to_open",
18118
+ "type": "numeric string",
18119
+ "GoogleBigQueryType": "numeric"
18120
+ },
18121
+ "instant_experience_clicks_to_start": {
18122
+ "description": "instant_experience_clicks_to_start",
18123
+ "type": "numeric string",
18124
+ "GoogleBigQueryType": "numeric"
18125
+ },
18126
+ "instant_experience_outbound_clicks": {
18127
+ "description": "instant_experience_outbound_clicks",
18128
+ "type": "list<AdsActionStats>"
18129
+ },
18130
+ "interactive_component_tap": {
18131
+ "description": "interactive_component_tap",
18132
+ "type": "list<AdsActionStats>"
18133
+ },
18134
+ "marketing_messages_delivery_rate": {
18135
+ "description": "The number of messages delivered divided by the number of messages sent. Some messages may not be delivered, such as when a customer's device is out of service. This metric doesn't include messages sent to Europe and Japan.",
18136
+ "type": "numeric string",
18137
+ "GoogleBigQueryType": "numeric"
18138
+ },
18139
+ "mobile_app_purchase_roas": {
18140
+ "description": "The total return on ad spend (ROAS) from mobile app purchases. This is based on the value that you assigned when you set up the app event.",
18141
+ "type": "list<AdsActionStats>"
18142
+ },
18143
+ "objective": {
18144
+ "description": "The objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.",
18145
+ "type": "string"
18146
+ },
18147
+ "optimization_goal": {
18148
+ "description": "The optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.",
18149
+ "type": "string"
18150
+ },
18151
+ "outbound_clicks": {
18152
+ "description": "The number of clicks on links that take people off Facebook-owned properties.",
18153
+ "type": "list<AdsActionStats>"
18154
+ },
18155
+ "outbound_clicks_ctr": {
18156
+ "description": "The percentage of times people saw your ad and performed an outbound click.",
18157
+ "type": "list<AdsActionStats>"
18158
+ },
18159
+ "product_id": {
18160
+ "description": "The ID of the product associated with the ad.",
18161
+ "type": "string"
18162
+ },
18163
+ "purchase_roas": {
18164
+ "description": "The total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.",
18165
+ "type": "list<AdsActionStats>"
18166
+ },
18167
+ "qualifying_question_qualify_answer_rate": {
18168
+ "description": "qualifying_question_qualify_answer_rate",
18169
+ "type": "numeric string",
18170
+ "GoogleBigQueryType": "numeric"
18171
+ },
18172
+ "reach": {
18173
+ "description": "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. This metric is estimated.",
18174
+ "type": "numeric string",
18175
+ "GoogleBigQueryType": "numeric"
18176
+ },
18177
+ "shops_assisted_purchases": {
18178
+ "description": "shops_assisted_purchases",
18179
+ "type": "string"
18180
+ },
18181
+ "social_spend": {
18182
+ "description": "The total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).",
18183
+ "type": "numeric string",
18184
+ "GoogleBigQueryType": "numeric"
18185
+ },
18186
+ "spend": {
18187
+ "description": "The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.",
18188
+ "type": "numeric string",
18189
+ "GoogleSheetsFormat": "$#,##0.00",
18190
+ "GoogleBigQueryType": "numeric"
18191
+ },
18192
+ "updated_time": {
18193
+ "description": "updated_time",
18194
+ "type": "string"
18195
+ },
18196
+ "video_30_sec_watched_actions": {
18197
+ "description": "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. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.",
18198
+ "type": "list<AdsActionStats>"
18199
+ },
18200
+ "video_avg_time_watched_actions": {
18201
+ "description": "The average time a video was played, including any time spent replaying the video for a single impression.",
18202
+ "type": "list<AdsActionStats>"
18203
+ },
18204
+ "video_continuous_2_sec_watched_actions": {
18205
+ "description": "video_continuous_2_sec_watched_actions",
18206
+ "type": "list<AdsActionStats>"
18207
+ },
18208
+ "video_p100_watched_actions": {
18209
+ "description": "The number of times your video was played at 100% of its length, including plays that skipped to this point.",
18210
+ "type": "list<AdsActionStats>"
18211
+ },
18212
+ "video_p25_watched_actions": {
18213
+ "description": "The number of times your video was played at 25% of its length, including plays that skipped to this point.",
18214
+ "type": "list<AdsActionStats>"
18215
+ },
18216
+ "video_p50_watched_actions": {
18217
+ "description": "The number of times your video was played at 50% of its length, including plays that skipped to this point.",
18218
+ "type": "list<AdsActionStats>"
18219
+ },
18220
+ "video_p75_watched_actions": {
18221
+ "description": "The number of times your video was played at 75% of its length, including plays that skipped to this point.",
18222
+ "type": "list<AdsActionStats>"
18223
+ },
18224
+ "video_p95_watched_actions": {
18225
+ "description": "The number of times your video was played at 95% of its length, including plays that skipped to this point.",
18226
+ "type": "list<AdsActionStats>"
18227
+ },
18228
+ "video_play_actions": {
18229
+ "description": "The number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.",
18230
+ "type": "list<AdsActionStats>"
18231
+ },
18232
+ "video_play_curve_actions": {
18233
+ "description": "A video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges [15 to 20), [20 to 25), and [25 to 30). Entries 18 to 20 represent second ranges [30 to 40), [40 to 50), and [50 to 60). Entry 21 represents plays over 60 seconds.",
18234
+ "type": "list<AdsHistogramStats>"
18235
+ },
18236
+ "video_play_retention_0_to_15s_actions": {
18237
+ "description": "video_play_retention_0_to_15s_actions",
18238
+ "type": "list<AdsHistogramStats>"
18239
+ },
18240
+ "video_play_retention_20_to_60s_actions": {
18241
+ "description": "video_play_retention_20_to_60s_actions",
18242
+ "type": "list<AdsHistogramStats>"
18243
+ },
18244
+ "video_play_retention_graph_actions": {
18245
+ "description": "video_play_retention_graph_actions",
18246
+ "type": "list<AdsHistogramStats>"
18247
+ },
18248
+ "video_time_watched_actions": {
18249
+ "description": "video_time_watched_actions",
18250
+ "type": "list<AdsActionStats>"
18251
+ },
18252
+ "website_ctr": {
18253
+ "description": "The percentage of times people saw your ad and performed a link click.",
18254
+ "type": "list<AdsActionStats>"
18255
+ },
18256
+ "website_purchase_roas": {
18257
+ "description": "The total return on ad spend (ROAS) from website purchases. This is based on the value of all conversions recorded by the Facebook pixel on your website and attributed to your ads.",
18258
+ "type": "list<AdsActionStats>"
18259
+ },
18260
+ "wish_bid": {
18261
+ "description": "wish_bid",
18262
+ "type": "numeric string",
18263
+ "GoogleBigQueryType": "numeric"
18264
+ }
18265
+ };
18266
+ var adAccountInsightsFieldsByLinkUrlAsset = {
18267
+ "account_currency": {
18268
+ "description": "Currency that is used by your ad account.",
18269
+ "type": "string"
18270
+ },
18271
+ "account_id": {
18272
+ "description": "The ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.",
18273
+ "type": "numeric string",
18274
+ "GoogleSheetsFormat": "@"
18275
+ },
18276
+ "account_name": {
18277
+ "description": "The name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.",
18278
+ "type": "string"
18279
+ },
18280
+ "action_values": {
18281
+ "description": "The total value of all conversions attributed to your ads.",
18282
+ "type": "list<AdsActionStats>"
18283
+ },
18284
+ "actions": {
18285
+ "description": "The total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.",
18286
+ "type": "list<AdsActionStats>"
18287
+ },
18288
+ "ad_click_actions": {
18289
+ "description": "ad_click_actions",
18290
+ "type": "list<AdsActionStats>"
18291
+ },
18292
+ "ad_id": {
18293
+ "description": "The unique ID of the ad you're viewing in reporting.",
18294
+ "type": "numeric string",
18295
+ "GoogleSheetsFormat": "@"
18296
+ },
18297
+ "ad_impression_actions": {
18298
+ "description": "ad_impression_actions",
18299
+ "type": "list<AdsActionStats>"
18300
+ },
18301
+ "ad_name": {
18302
+ "description": "The name of the ad you're viewing in reporting.",
18303
+ "type": "string"
18304
+ },
18305
+ "adset_id": {
18306
+ "description": "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.",
18307
+ "type": "numeric string",
18308
+ "GoogleSheetsFormat": "@"
18309
+ },
18310
+ "adset_name": {
18311
+ "description": "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.",
18312
+ "type": "string"
18313
+ },
18314
+ "attribution_setting": {
18315
+ "description": "The default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.",
18316
+ "type": "string"
18317
+ },
18318
+ "auction_bid": {
18319
+ "description": "auction_bid",
18320
+ "type": "numeric string",
18321
+ "GoogleBigQueryType": "numeric"
18322
+ },
18323
+ "auction_competitiveness": {
18324
+ "description": "auction_competitiveness",
18325
+ "type": "numeric string",
18326
+ "GoogleBigQueryType": "numeric"
18327
+ },
18328
+ "auction_max_competitor_bid": {
18329
+ "description": "auction_max_competitor_bid",
18330
+ "type": "numeric string",
18331
+ "GoogleBigQueryType": "numeric"
18332
+ },
18333
+ "buying_type": {
18334
+ "description": "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. This field is currently only visible at the campaign level.",
18335
+ "type": "string"
18336
+ },
18337
+ "campaign_id": {
18338
+ "description": "The unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.",
18339
+ "type": "numeric string",
18340
+ "GoogleSheetsFormat": "@"
18341
+ },
18342
+ "campaign_name": {
18343
+ "description": "The name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.",
18344
+ "type": "string"
18345
+ },
18346
+ "canvas_avg_view_percent": {
18347
+ "description": "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. It may include a series of interactive or multimedia components, including video, images product catalog and more.",
18348
+ "type": "numeric string",
18349
+ "GoogleBigQueryType": "numeric"
18350
+ },
18351
+ "canvas_avg_view_time": {
18352
+ "description": "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. It may include a series of interactive or multimedia components, including video, images product catalog and more.",
18353
+ "type": "numeric string",
18354
+ "GoogleBigQueryType": "numeric"
18355
+ },
18356
+ "catalog_segment_actions": {
18357
+ "description": "The number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.",
18358
+ "type": "list<AdsActionStats>"
18359
+ },
18360
+ "catalog_segment_value": {
18361
+ "description": "The total value of all conversions from your catalog segment attributed to your ads.",
18362
+ "type": "list<AdsActionStats>"
18363
+ },
18364
+ "catalog_segment_value_mobile_purchase_roas": {
18365
+ "description": "The total return on ad spend (ROAS) from mobile app purchases for your catalog segment.",
18366
+ "type": "list<AdsActionStats>"
18367
+ },
18368
+ "catalog_segment_value_omni_purchase_roas": {
18369
+ "description": "The total return on ad spend (ROAS) from all purchases for your catalog segment.",
18370
+ "type": "list<AdsActionStats>"
18371
+ },
18372
+ "catalog_segment_value_website_purchase_roas": {
18373
+ "description": "The total return on ad spend (ROAS) from website purchases for your catalog segment.",
18374
+ "type": "list<AdsActionStats>"
18375
+ },
18376
+ "clicks": {
18377
+ "description": "The number of clicks on your ads.",
18378
+ "type": "numeric string",
18379
+ "GoogleBigQueryType": "numeric"
18380
+ },
18381
+ "conversion_values": {
18382
+ "description": "conversion_values",
18383
+ "type": "list<AdsActionStats>"
18384
+ },
18385
+ "conversions": {
18386
+ "description": "conversions",
18387
+ "type": "list<AdsActionStats>"
18388
+ },
18389
+ "converted_product_quantity": {
18390
+ "description": "The number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.",
18391
+ "type": "list<AdsActionStats>"
18392
+ },
18393
+ "converted_product_value": {
18394
+ "description": "The value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.",
18395
+ "type": "list<AdsActionStats>"
18396
+ },
18397
+ "cost_per_15_sec_video_view": {
18398
+ "description": "cost_per_15_sec_video_view",
18399
+ "type": "list<AdsActionStats>"
18400
+ },
18401
+ "cost_per_2_sec_continuous_video_view": {
18402
+ "description": "cost_per_2_sec_continuous_video_view",
18403
+ "type": "list<AdsActionStats>"
18404
+ },
18405
+ "cost_per_action_type": {
18406
+ "description": "The average cost of a relevant action.",
18407
+ "type": "list<AdsActionStats>"
18408
+ },
18409
+ "cost_per_ad_click": {
18410
+ "description": "cost_per_ad_click",
18411
+ "type": "list<AdsActionStats>"
18412
+ },
18413
+ "cost_per_conversion": {
18414
+ "description": "cost_per_conversion",
18415
+ "type": "list<AdsActionStats>"
18416
+ },
18417
+ "cost_per_dda_countby_convs": {
18418
+ "description": "cost_per_dda_countby_convs",
18419
+ "type": "numeric string",
18420
+ "GoogleBigQueryType": "numeric"
18421
+ },
18422
+ "cost_per_inline_link_click": {
18423
+ "description": "The average cost of each inline link click.",
18424
+ "type": "numeric string",
18425
+ "GoogleBigQueryType": "numeric"
18426
+ },
18427
+ "cost_per_inline_post_engagement": {
18428
+ "description": "The average cost of each inline post engagement.",
18429
+ "type": "numeric string",
18430
+ "GoogleBigQueryType": "numeric"
18431
+ },
18432
+ "cost_per_one_thousand_ad_impression": {
18433
+ "description": "cost_per_one_thousand_ad_impression",
18434
+ "type": "list<AdsActionStats>"
18435
+ },
18436
+ "cost_per_outbound_click": {
18437
+ "description": "The average cost for each outbound click.",
18438
+ "type": "list<AdsActionStats>"
18439
+ },
18440
+ "cost_per_thruplay": {
18441
+ "description": "The average cost for each ThruPlay. This metric is in development.",
18442
+ "type": "list<AdsActionStats>"
18443
+ },
18444
+ "cost_per_unique_action_type": {
18445
+ "description": "The average cost of each unique action. This metric is estimated.",
18446
+ "type": "list<AdsActionStats>"
18447
+ },
18448
+ "cost_per_unique_click": {
18449
+ "description": "The average cost for each unique click (all). This metric is estimated.",
18450
+ "type": "numeric string",
18451
+ "GoogleBigQueryType": "numeric"
18452
+ },
18453
+ "cost_per_unique_conversion": {
18454
+ "description": "cost_per_unique_conversion",
18455
+ "type": "list<AdsActionStats>"
18456
+ },
18457
+ "cost_per_unique_inline_link_click": {
18458
+ "description": "The average cost of each unique inline link click. This metric is estimated.",
18459
+ "type": "numeric string",
18460
+ "GoogleBigQueryType": "numeric"
18461
+ },
18462
+ "cost_per_unique_outbound_click": {
18463
+ "description": "The average cost for each unique outbound click. This metric is estimated.",
18464
+ "type": "list<AdsActionStats>"
18465
+ },
18466
+ "cpc": {
18467
+ "description": "The average cost for each click (all).",
18468
+ "type": "numeric string",
18469
+ "GoogleBigQueryType": "numeric"
18470
+ },
18471
+ "cpm": {
18472
+ "description": "The average cost for 1,000 impressions.",
18473
+ "type": "numeric string",
18474
+ "GoogleBigQueryType": "numeric"
18475
+ },
18476
+ "cpp": {
18477
+ "description": "The average cost to reach 1,000 people. This metric is estimated.",
18478
+ "type": "numeric string",
18479
+ "GoogleBigQueryType": "numeric"
18480
+ },
18481
+ "created_time": {
18482
+ "description": "created_time",
18483
+ "type": "string"
18484
+ },
18485
+ "ctr": {
18486
+ "description": "The percentage of times people saw your ad and performed a click (all).",
18487
+ "type": "numeric string",
18488
+ "GoogleBigQueryType": "numeric"
18489
+ },
18490
+ "date_start": {
18491
+ "description": "The start date for your data. This is controlled by the date range you've selected for your reporting view.",
18492
+ "type": "string",
18493
+ "GoogleBigQueryType": "date",
18494
+ "GoogleBigQueryPartitioned": true
18495
+ },
18496
+ "date_stop": {
18497
+ "description": "The end date for your data. This is controlled by the date range you've selected for your reporting view.",
18498
+ "type": "string",
18499
+ "GoogleBigQueryType": "date"
18500
+ },
18501
+ "dda_countby_convs": {
18502
+ "description": "dda_countby_convs",
18503
+ "type": "numeric string",
18504
+ "GoogleBigQueryType": "numeric"
18505
+ },
18506
+ "dda_results": {
18507
+ "description": "dda_results",
18508
+ "type": "list<AdsInsightsDdaResult>"
18509
+ },
18510
+ "frequency": {
18511
+ "description": "The average number of times each person saw your ad. This metric is estimated.",
18512
+ "type": "numeric string",
18513
+ "GoogleBigQueryType": "numeric"
18514
+ },
18515
+ "full_view_impressions": {
18516
+ "description": "The number of Full Views on your Page's posts as a result of your ad.",
18517
+ "type": "numeric string",
18518
+ "GoogleBigQueryType": "numeric"
18519
+ },
18520
+ "full_view_reach": {
18521
+ "description": "The number of people who performed a Full View on your Page's post as a result of your ad.",
18522
+ "type": "numeric string",
18523
+ "GoogleBigQueryType": "numeric"
18524
+ },
18525
+ "impressions": {
18526
+ "description": "The number of times your ads were on screen.",
18527
+ "type": "numeric string",
18528
+ "GoogleBigQueryType": "numeric"
18529
+ },
18530
+ "inline_link_click_ctr": {
18531
+ "description": "The percentage of time people saw your ads and performed an inline link click.",
18532
+ "type": "numeric string",
18533
+ "GoogleBigQueryType": "numeric"
18534
+ },
18535
+ "inline_link_clicks": {
18536
+ "description": "The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties. Inline link clicks use a fixed 1-day-click attribution window.",
18537
+ "type": "numeric string",
18538
+ "GoogleBigQueryType": "numeric"
18539
+ },
18540
+ "inline_post_engagement": {
18541
+ "description": "The total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.",
18542
+ "type": "numeric string",
18543
+ "GoogleBigQueryType": "numeric"
18544
+ },
18545
+ "instagram_upcoming_event_reminders_set": {
18546
+ "description": "instagram_upcoming_event_reminders_set",
18547
+ "type": "numeric string",
18548
+ "GoogleBigQueryType": "numeric"
18549
+ },
18550
+ "instant_experience_clicks_to_open": {
18551
+ "description": "instant_experience_clicks_to_open",
18552
+ "type": "numeric string",
18553
+ "GoogleBigQueryType": "numeric"
18554
+ },
18555
+ "instant_experience_clicks_to_start": {
18556
+ "description": "instant_experience_clicks_to_start",
18557
+ "type": "numeric string",
18558
+ "GoogleBigQueryType": "numeric"
18559
+ },
18560
+ "instant_experience_outbound_clicks": {
18561
+ "description": "instant_experience_outbound_clicks",
18562
+ "type": "list<AdsActionStats>"
18563
+ },
18564
+ "interactive_component_tap": {
18565
+ "description": "interactive_component_tap",
18566
+ "type": "list<AdsActionStats>"
18567
+ },
18568
+ "link_url_asset": {
18569
+ "description": "The ID of the URL asset involved in impression, click or action.",
18570
+ "type": "object"
18571
+ },
18572
+ "marketing_messages_delivery_rate": {
18573
+ "description": "The number of messages delivered divided by the number of messages sent. Some messages may not be delivered, such as when a customer's device is out of service. This metric doesn't include messages sent to Europe and Japan.",
18574
+ "type": "numeric string",
18575
+ "GoogleBigQueryType": "numeric"
18576
+ },
18577
+ "mobile_app_purchase_roas": {
18578
+ "description": "The total return on ad spend (ROAS) from mobile app purchases. This is based on the value that you assigned when you set up the app event.",
18579
+ "type": "list<AdsActionStats>"
16444
18580
  },
16445
- "creative_asset_groups_spec": {
16446
- "description": "This field is used to create ads using the Flexible ad format. You can read more about that here",
16447
- "type": "AdCreativeAssetGroupsSpec"
18581
+ "objective": {
18582
+ "description": "The objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.",
18583
+ "type": "string"
16448
18584
  },
16449
- "effective_status": {
16450
- "description": "The effective status of the ad. The status could be effective either because of its own status, or the status of its parent units. WITH_ISSUES is available for version 3.2 or higher. IN_PROCESS is available for version 4.0 or higher",
16451
- "type": "enum {ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED, IN_PROCESS, WITH_ISSUES}"
18585
+ "optimization_goal": {
18586
+ "description": "The optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.",
18587
+ "type": "string"
16452
18588
  },
16453
- "issues_info": {
16454
- "description": "Issues for this ad that prevented it from delivering",
16455
- "type": "list<AdgroupIssuesInfo>"
18589
+ "outbound_clicks": {
18590
+ "description": "The number of clicks on links that take people off Facebook-owned properties.",
18591
+ "type": "list<AdsActionStats>"
16456
18592
  },
16457
- "last_updated_by_app_id": {
16458
- "description": "Indicates the app used for the most recent update of the ad.",
16459
- "type": "id"
18593
+ "outbound_clicks_ctr": {
18594
+ "description": "The percentage of times people saw your ad and performed an outbound click.",
18595
+ "type": "list<AdsActionStats>"
16460
18596
  },
16461
- "name": {
16462
- "description": "Name of the ad.",
18597
+ "purchase_roas": {
18598
+ "description": "The total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.",
18599
+ "type": "list<AdsActionStats>"
18600
+ },
18601
+ "qualifying_question_qualify_answer_rate": {
18602
+ "description": "qualifying_question_qualify_answer_rate",
18603
+ "type": "numeric string",
18604
+ "GoogleBigQueryType": "numeric"
18605
+ },
18606
+ "reach": {
18607
+ "description": "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. This metric is estimated.",
18608
+ "type": "numeric string",
18609
+ "GoogleBigQueryType": "numeric"
18610
+ },
18611
+ "shops_assisted_purchases": {
18612
+ "description": "shops_assisted_purchases",
16463
18613
  "type": "string"
16464
18614
  },
16465
- "preview_shareable_link": {
16466
- "description": "A link that enables users to preview ads in different placements",
18615
+ "social_spend": {
18616
+ "description": "The total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).",
18617
+ "type": "numeric string",
18618
+ "GoogleBigQueryType": "numeric"
18619
+ },
18620
+ "spend": {
18621
+ "description": "The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.",
18622
+ "type": "numeric string",
18623
+ "GoogleSheetsFormat": "$#,##0.00",
18624
+ "GoogleBigQueryType": "numeric"
18625
+ },
18626
+ "updated_time": {
18627
+ "description": "updated_time",
16467
18628
  "type": "string"
16468
18629
  },
16469
- "recommendations": {
16470
- "description": "If there are recommendations for this ad, this field includes them. Otherwise, it is not included in the response. Field not included in redownload mode.",
16471
- "type": "list<AdRecommendation>"
18630
+ "video_30_sec_watched_actions": {
18631
+ "description": "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. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.",
18632
+ "type": "list<AdsActionStats>"
16472
18633
  },
16473
- "source_ad": {
16474
- "description": "The source ad that this ad is copied from",
16475
- "type": "Ad"
18634
+ "video_avg_time_watched_actions": {
18635
+ "description": "The average time a video was played, including any time spent replaying the video for a single impression.",
18636
+ "type": "list<AdsActionStats>"
16476
18637
  },
16477
- "source_ad_id": {
16478
- "description": "The source ad id that this ad is copied from",
16479
- "type": "numeric string"
18638
+ "video_continuous_2_sec_watched_actions": {
18639
+ "description": "video_continuous_2_sec_watched_actions",
18640
+ "type": "list<AdsActionStats>"
16480
18641
  },
16481
- "status": {
16482
- "description": "The configured status of the ad. The field returns the same value as configured_status. Use this field, instead of configured_status.",
16483
- "type": "enum {ACTIVE, PAUSED, DELETED, ARCHIVED}"
18642
+ "video_p100_watched_actions": {
18643
+ "description": "The number of times your video was played at 100% of its length, including plays that skipped to this point.",
18644
+ "type": "list<AdsActionStats>"
16484
18645
  },
16485
- "tracking_specs": {
16486
- "description": "With tracking specs, you log actions taken by people on your ad. This field takes arguments identical to action spec. See Tracking and Conversion Specs.",
16487
- "type": "list<ConversionActionQuery>"
18646
+ "video_p25_watched_actions": {
18647
+ "description": "The number of times your video was played at 25% of its length, including plays that skipped to this point.",
18648
+ "type": "list<AdsActionStats>"
16488
18649
  },
16489
- "updated_time": {
16490
- "description": "Time when this ad was updated.",
16491
- "type": "datetime"
16492
- }
16493
- };
16494
- var adAccountUserFields = {
16495
- "id": {
16496
- "description": "ID of the App Scoped User",
16497
- "type": "numeric string"
18650
+ "video_p50_watched_actions": {
18651
+ "description": "The number of times your video was played at 50% of its length, including plays that skipped to this point.",
18652
+ "type": "list<AdsActionStats>"
16498
18653
  },
16499
- "name": {
16500
- "description": "User public full name",
16501
- "type": "string"
18654
+ "video_p75_watched_actions": {
18655
+ "description": "The number of times your video was played at 75% of its length, including plays that skipped to this point.",
18656
+ "type": "list<AdsActionStats>"
18657
+ },
18658
+ "video_p95_watched_actions": {
18659
+ "description": "The number of times your video was played at 95% of its length, including plays that skipped to this point.",
18660
+ "type": "list<AdsActionStats>"
18661
+ },
18662
+ "video_play_actions": {
18663
+ "description": "The number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.",
18664
+ "type": "list<AdsActionStats>"
18665
+ },
18666
+ "video_play_curve_actions": {
18667
+ "description": "A video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges [15 to 20), [20 to 25), and [25 to 30). Entries 18 to 20 represent second ranges [30 to 40), [40 to 50), and [50 to 60). Entry 21 represents plays over 60 seconds.",
18668
+ "type": "list<AdsHistogramStats>"
18669
+ },
18670
+ "video_play_retention_0_to_15s_actions": {
18671
+ "description": "video_play_retention_0_to_15s_actions",
18672
+ "type": "list<AdsHistogramStats>"
18673
+ },
18674
+ "video_play_retention_20_to_60s_actions": {
18675
+ "description": "video_play_retention_20_to_60s_actions",
18676
+ "type": "list<AdsHistogramStats>"
18677
+ },
18678
+ "video_play_retention_graph_actions": {
18679
+ "description": "video_play_retention_graph_actions",
18680
+ "type": "list<AdsHistogramStats>"
18681
+ },
18682
+ "video_time_watched_actions": {
18683
+ "description": "video_time_watched_actions",
18684
+ "type": "list<AdsActionStats>"
18685
+ },
18686
+ "website_ctr": {
18687
+ "description": "The percentage of times people saw your ad and performed a link click.",
18688
+ "type": "list<AdsActionStats>"
18689
+ },
18690
+ "website_purchase_roas": {
18691
+ "description": "The total return on ad spend (ROAS) from website purchases. This is based on the value of all conversions recorded by the Facebook pixel on your website and attributed to your ads.",
18692
+ "type": "list<AdsActionStats>"
18693
+ },
18694
+ "wish_bid": {
18695
+ "description": "wish_bid",
18696
+ "type": "numeric string",
18697
+ "GoogleBigQueryType": "numeric"
16502
18698
  }
16503
- // Commented because this field is lead to mistake despite to presence in schema.
16504
- // 'tasks': {
16505
- // 'description': 'Tasks of App Scoped User',
16506
- // 'type': 'list<string>'
16507
- // }
16508
18699
  };
16509
- var adAccountInsightsFields = {
18700
+ var adAccountInsightsFieldsByDevicePlatform = {
16510
18701
  "account_currency": {
16511
18702
  "description": "Currency that is used by your ad account.",
16512
18703
  "type": "string"
@@ -16573,10 +18764,6 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
16573
18764
  "type": "numeric string",
16574
18765
  "GoogleBigQueryType": "numeric"
16575
18766
  },
16576
- "body_asset": {
16577
- "description": "body_asset",
16578
- "type": "AdAssetBody"
16579
- },
16580
18767
  "buying_type": {
16581
18768
  "description": "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. This field is currently only visible at the campaign level.",
16582
18769
  "type": "string"
@@ -16754,9 +18941,9 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
16754
18941
  "description": "dda_results",
16755
18942
  "type": "list<AdsInsightsDdaResult>"
16756
18943
  },
16757
- "description_asset": {
16758
- "description": "description_asset",
16759
- "type": "AdAssetDescription"
18944
+ "device_platform": {
18945
+ "description": "device_platform",
18946
+ "type": "string"
16760
18947
  },
16761
18948
  "frequency": {
16762
18949
  "description": "The average number of times each person saw your ad. This metric is estimated.",
@@ -16773,10 +18960,6 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
16773
18960
  "type": "numeric string",
16774
18961
  "GoogleBigQueryType": "numeric"
16775
18962
  },
16776
- "image_asset": {
16777
- "description": "image_asset",
16778
- "type": "AdAssetImage"
16779
- },
16780
18963
  "impressions": {
16781
18964
  "description": "The number of times your ads were on screen.",
16782
18965
  "type": "numeric string",
@@ -16874,26 +19057,14 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
16874
19057
  "GoogleSheetsFormat": "$#,##0.00",
16875
19058
  "GoogleBigQueryType": "numeric"
16876
19059
  },
16877
- "title_asset": {
16878
- "description": "title_asset",
16879
- "type": "AdAssetTitle"
16880
- },
16881
19060
  "updated_time": {
16882
19061
  "description": "updated_time",
16883
19062
  "type": "string"
16884
19063
  },
16885
- "user_segment_key": {
16886
- "description": "user_segment_key",
16887
- "type": "string"
16888
- },
16889
19064
  "video_30_sec_watched_actions": {
16890
19065
  "description": "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. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.",
16891
19066
  "type": "list<AdsActionStats>"
16892
19067
  },
16893
- "video_asset": {
16894
- "description": "video_asset",
16895
- "type": "AdAssetVideo"
16896
- },
16897
19068
  "video_avg_time_watched_actions": {
16898
19069
  "description": "The average time a video was played, including any time spent replaying the video for a single impression.",
16899
19070
  "type": "list<AdsActionStats>"
@@ -16960,7 +19131,7 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
16960
19131
  "GoogleBigQueryType": "numeric"
16961
19132
  }
16962
19133
  };
16963
- var adAccountInsightsFieldsByLinkUrlAsset = {
19134
+ var adAccountInsightsFieldsByCountry = {
16964
19135
  "account_currency": {
16965
19136
  "description": "Currency that is used by your ad account.",
16966
19137
  "type": "string"
@@ -17027,10 +19198,6 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17027
19198
  "type": "numeric string",
17028
19199
  "GoogleBigQueryType": "numeric"
17029
19200
  },
17030
- "body_asset": {
17031
- "description": "body_asset",
17032
- "type": "AdAssetBody"
17033
- },
17034
19201
  "buying_type": {
17035
19202
  "description": "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. This field is currently only visible at the campaign level.",
17036
19203
  "type": "string"
@@ -17079,6 +19246,10 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17079
19246
  "type": "numeric string",
17080
19247
  "GoogleBigQueryType": "numeric"
17081
19248
  },
19249
+ "country": {
19250
+ "description": "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.",
19251
+ "type": "string"
19252
+ },
17082
19253
  "conversion_values": {
17083
19254
  "description": "conversion_values",
17084
19255
  "type": "list<AdsActionStats>"
@@ -17208,10 +19379,6 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17208
19379
  "description": "dda_results",
17209
19380
  "type": "list<AdsInsightsDdaResult>"
17210
19381
  },
17211
- "description_asset": {
17212
- "description": "description_asset",
17213
- "type": "AdAssetDescription"
17214
- },
17215
19382
  "frequency": {
17216
19383
  "description": "The average number of times each person saw your ad. This metric is estimated.",
17217
19384
  "type": "numeric string",
@@ -17227,10 +19394,6 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17227
19394
  "type": "numeric string",
17228
19395
  "GoogleBigQueryType": "numeric"
17229
19396
  },
17230
- "image_asset": {
17231
- "description": "image_asset",
17232
- "type": "AdAssetImage"
17233
- },
17234
19397
  "impressions": {
17235
19398
  "description": "The number of times your ads were on screen.",
17236
19399
  "type": "numeric string",
@@ -17274,10 +19437,6 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17274
19437
  "description": "interactive_component_tap",
17275
19438
  "type": "list<AdsActionStats>"
17276
19439
  },
17277
- "link_url_asset": {
17278
- "description": "The ID of the URL asset involved in impression, click or action.",
17279
- "type": "object"
17280
- },
17281
19440
  "marketing_messages_delivery_rate": {
17282
19441
  "description": "The number of messages delivered divided by the number of messages sent. Some messages may not be delivered, such as when a customer's device is out of service. This metric doesn't include messages sent to Europe and Japan.",
17283
19442
  "type": "numeric string",
@@ -17332,26 +19491,14 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17332
19491
  "GoogleSheetsFormat": "$#,##0.00",
17333
19492
  "GoogleBigQueryType": "numeric"
17334
19493
  },
17335
- "title_asset": {
17336
- "description": "title_asset",
17337
- "type": "AdAssetTitle"
17338
- },
17339
19494
  "updated_time": {
17340
19495
  "description": "updated_time",
17341
19496
  "type": "string"
17342
19497
  },
17343
- "user_segment_key": {
17344
- "description": "user_segment_key",
17345
- "type": "string"
17346
- },
17347
19498
  "video_30_sec_watched_actions": {
17348
19499
  "description": "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. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.",
17349
19500
  "type": "list<AdsActionStats>"
17350
19501
  },
17351
- "video_asset": {
17352
- "description": "video_asset",
17353
- "type": "AdAssetVideo"
17354
- },
17355
19502
  "video_avg_time_watched_actions": {
17356
19503
  "description": "The average time a video was played, including any time spent replaying the video for a single impression.",
17357
19504
  "type": "list<AdsActionStats>"
@@ -17418,7 +19565,7 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17418
19565
  "GoogleBigQueryType": "numeric"
17419
19566
  }
17420
19567
  };
17421
- var adAccountInsightsFieldsByCountry = {
19568
+ var adAccountInsightsFieldsByAgeAndGender = {
17422
19569
  "account_currency": {
17423
19570
  "description": "Currency that is used by your ad account.",
17424
19571
  "type": "string"
@@ -17466,6 +19613,10 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17466
19613
  "description": "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.",
17467
19614
  "type": "string"
17468
19615
  },
19616
+ "age": {
19617
+ "description": "The age range of the people who saw your ad. This is based on the age people have listed in their Facebook profiles.",
19618
+ "type": "string"
19619
+ },
17469
19620
  "attribution_setting": {
17470
19621
  "description": "The default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.",
17471
19622
  "type": "string"
@@ -17485,10 +19636,6 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17485
19636
  "type": "numeric string",
17486
19637
  "GoogleBigQueryType": "numeric"
17487
19638
  },
17488
- "body_asset": {
17489
- "description": "body_asset",
17490
- "type": "AdAssetBody"
17491
- },
17492
19639
  "buying_type": {
17493
19640
  "description": "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. This field is currently only visible at the campaign level.",
17494
19641
  "type": "string"
@@ -17537,10 +19684,6 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17537
19684
  "type": "numeric string",
17538
19685
  "GoogleBigQueryType": "numeric"
17539
19686
  },
17540
- "country": {
17541
- "description": "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.",
17542
- "type": "string"
17543
- },
17544
19687
  "conversion_values": {
17545
19688
  "description": "conversion_values",
17546
19689
  "type": "list<AdsActionStats>"
@@ -17670,10 +19813,6 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17670
19813
  "description": "dda_results",
17671
19814
  "type": "list<AdsInsightsDdaResult>"
17672
19815
  },
17673
- "description_asset": {
17674
- "description": "description_asset",
17675
- "type": "AdAssetDescription"
17676
- },
17677
19816
  "frequency": {
17678
19817
  "description": "The average number of times each person saw your ad. This metric is estimated.",
17679
19818
  "type": "numeric string",
@@ -17689,9 +19828,9 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17689
19828
  "type": "numeric string",
17690
19829
  "GoogleBigQueryType": "numeric"
17691
19830
  },
17692
- "image_asset": {
17693
- "description": "image_asset",
17694
- "type": "AdAssetImage"
19831
+ "gender": {
19832
+ "description": "The gender of the people who saw your ad. This is based on the gender people have listed in their Facebook profiles.",
19833
+ "type": "string"
17695
19834
  },
17696
19835
  "impressions": {
17697
19836
  "description": "The number of times your ads were on screen.",
@@ -17790,26 +19929,14 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
17790
19929
  "GoogleSheetsFormat": "$#,##0.00",
17791
19930
  "GoogleBigQueryType": "numeric"
17792
19931
  },
17793
- "title_asset": {
17794
- "description": "title_asset",
17795
- "type": "AdAssetTitle"
17796
- },
17797
19932
  "updated_time": {
17798
19933
  "description": "updated_time",
17799
19934
  "type": "string"
17800
19935
  },
17801
- "user_segment_key": {
17802
- "description": "user_segment_key",
17803
- "type": "string"
17804
- },
17805
19936
  "video_30_sec_watched_actions": {
17806
19937
  "description": "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. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.",
17807
19938
  "type": "list<AdsActionStats>"
17808
19939
  },
17809
- "video_asset": {
17810
- "description": "video_asset",
17811
- "type": "AdAssetVideo"
17812
- },
17813
19940
  "video_avg_time_watched_actions": {
17814
19941
  "description": "The average time a video was played, including any time spent replaying the video for a single impression.",
17815
19942
  "type": "list<AdsActionStats>"
@@ -18493,6 +20620,16 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
18493
20620
  "destinationName": "facebook_ads_ad_account_insights",
18494
20621
  "limit": 500
18495
20622
  },
20623
+ "ad-account/insights-by-age-and-gender": {
20624
+ "description": "Interface for insights with breakdown by age and gender.",
20625
+ "documentation": "https://developers.facebook.com/docs/marketing-api/reference/ad-account/insights",
20626
+ "fields": adAccountInsightsFieldsByAgeAndGender,
20627
+ "breakdowns": ["age", "gender"],
20628
+ "uniqueKeys": ["ad_id", "date_start", "date_stop", "age", "gender"],
20629
+ "isTimeSeries": true,
20630
+ "destinationName": "facebook_ads_ad_account_insights_by_age_and_gender",
20631
+ "limit": 500
20632
+ },
18496
20633
  "ad-account/insights-by-country": {
18497
20634
  "description": "Interface for insights with breakdown by country.",
18498
20635
  "documentation": "https://developers.facebook.com/docs/marketing-api/reference/ad-account/insights",
@@ -18503,6 +20640,16 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
18503
20640
  "destinationName": "facebook_ads_ad_account_insights_by_country",
18504
20641
  "limit": 500
18505
20642
  },
20643
+ "ad-account/insights-by-device-platform": {
20644
+ "description": "Interface for insights with breakdown by device platform.",
20645
+ "documentation": "https://developers.facebook.com/docs/marketing-api/reference/ad-account/insights",
20646
+ "fields": adAccountInsightsFieldsByDevicePlatform,
20647
+ "breakdowns": ["device_platform"],
20648
+ "uniqueKeys": ["ad_id", "date_start", "date_stop", "device_platform"],
20649
+ "isTimeSeries": true,
20650
+ "destinationName": "facebook_ads_ad_account_insights_by_device_platform",
20651
+ "limit": 500
20652
+ },
18506
20653
  "ad-account/insights-by-link-url-asset": {
18507
20654
  "description": "Interface for insights with breakdown by link URL asset.",
18508
20655
  "documentation": "https://developers.facebook.com/docs/marketing-api/reference/ad-account/insights",
@@ -18513,6 +20660,36 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
18513
20660
  "destinationName": "facebook_ads_ad_account_insights_by_link_url_asset",
18514
20661
  "limit": 500
18515
20662
  },
20663
+ "ad-account/insights-by-product-id": {
20664
+ "description": "Interface for insights with breakdown by product ID.",
20665
+ "documentation": "https://developers.facebook.com/docs/marketing-api/reference/ad-account/insights",
20666
+ "fields": adAccountInsightsFieldsByProductId,
20667
+ "breakdowns": ["product_id"],
20668
+ "uniqueKeys": ["ad_id", "date_start", "date_stop", "product_id"],
20669
+ "isTimeSeries": true,
20670
+ "destinationName": "facebook_ads_ad_account_insights_by_product_id",
20671
+ "limit": 500
20672
+ },
20673
+ "ad-account/insights-by-publisher-platform-and-position": {
20674
+ "description": "Interface for insights with breakdown by publisher platform and position.",
20675
+ "documentation": "https://developers.facebook.com/docs/marketing-api/reference/ad-account/insights",
20676
+ "fields": adAccountInsightsFieldsByPublisherPlatformAndPosition,
20677
+ "breakdowns": ["publisher_platform", "platform_position"],
20678
+ "uniqueKeys": ["ad_id", "date_start", "date_stop", "publisher_platform", "platform_position"],
20679
+ "isTimeSeries": true,
20680
+ "destinationName": "facebook_ads_ad_account_insights_by_publisher_platform_and_position",
20681
+ "limit": 500
20682
+ },
20683
+ "ad-account/insights-by-region": {
20684
+ "description": "Interface for insights with breakdown by region.",
20685
+ "documentation": "https://developers.facebook.com/docs/marketing-api/reference/ad-account/insights",
20686
+ "fields": adAccountInsightsFieldsByRegion,
20687
+ "breakdowns": ["region"],
20688
+ "uniqueKeys": ["ad_id", "date_start", "date_stop", "region"],
20689
+ "isTimeSeries": true,
20690
+ "destinationName": "facebook_ads_ad_account_insights_by_region",
20691
+ "limit": 500
20692
+ },
18516
20693
  "ad-group": {
18517
20694
  "overview": "Ad",
18518
20695
  "description": "Contains information for an ad, such as creative elements and measurement information.",
@@ -18728,16 +20905,21 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
18728
20905
  case "ad-account/insights":
18729
20906
  case "ad-account/insights-by-country":
18730
20907
  case "ad-account/insights-by-link-url-asset":
20908
+ case "ad-account/insights-by-publisher-platform-and-position":
20909
+ case "ad-account/insights-by-device-platform":
20910
+ case "ad-account/insights-by-region":
20911
+ case "ad-account/insights-by-product-id":
20912
+ case "ad-account/insights-by-age-and-gender":
18731
20913
  return this._fetchInsightsData({ nodeName, accountId, fields, timeRange, url });
18732
20914
  case "ad-group":
18733
- url += `act_${accountId}/ads?fields=${fields.join(",")}&limit=${this.fieldsSchema[nodeName].limit}`;
20915
+ url += `act_${accountId}/ads?fields=${this._buildFieldsString({ nodeName, fields })}&limit=${this.fieldsSchema[nodeName].limit}`;
18734
20916
  break;
18735
20917
  default:
18736
20918
  throw new Error(`End point for ${nodeName} is not implemented yet. Feel free add idea here: https://github.com/OWOX/owox-data-marts/discussions/categories/ideas`);
18737
20919
  }
18738
20920
  console.log(`Facebook API URL:`, url);
18739
20921
  url += `&access_token=${this.config.AccessToken.value}`;
18740
- return this._fetchPaginatedData(url, nodeName);
20922
+ return this._fetchPaginatedData(url, nodeName, fields);
18741
20923
  }
18742
20924
  //---- castRecordFields -------------------------------------------------
18743
20925
  /**
@@ -18810,7 +20992,7 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
18810
20992
  nodeName,
18811
20993
  url
18812
20994
  });
18813
- const allData = this._fetchPaginatedData(requestUrl, nodeName);
20995
+ const allData = this._fetchPaginatedData(requestUrl, nodeName, fields);
18814
20996
  if (this.config.ProcessShortLinks.value && allData.length > 0 && allData.some((record) => record.link_url_asset)) {
18815
20997
  return processShortLinks(allData, {
18816
20998
  shortLinkField: "link_url_asset",
@@ -18852,6 +21034,7 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
18852
21034
  * @private
18853
21035
  */
18854
21036
  _buildInsightsUrl({ accountId, fields, breakdowns, timeRange, nodeName, url }) {
21037
+ console.log("Insights request fields for", nodeName, ":", fields);
18855
21038
  let insightsUrl = `${url}act_${accountId}/insights?level=ad&period=day&time_range=${timeRange}&fields=${fields.join(",")}&limit=${this.fieldsSchema[nodeName].limit}`;
18856
21039
  if (breakdowns.length > 0) {
18857
21040
  insightsUrl += `&breakdowns=${breakdowns.join(",")}`;
@@ -18860,17 +21043,97 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
18860
21043
  insightsUrl += `&access_token=${this.config.AccessToken.value}`;
18861
21044
  return insightsUrl;
18862
21045
  }
21046
+ //---- _buildFieldsString ------------------------------------------------
21047
+ /**
21048
+ * Build fields string for Facebook API request
21049
+ * Filters out fields that don't exist in schema
21050
+ * Handles nested fields using Facebook's syntax: parent{field1,field2}
21051
+ *
21052
+ * @param {Object} params - Parameters object
21053
+ * @param {string} params.nodeName - Node name
21054
+ * @param {Array} params.fields - Fields to fetch
21055
+ * @return {string} Fields string for API request
21056
+ * @private
21057
+ */
21058
+ _buildFieldsString({ nodeName, fields }) {
21059
+ const nestedFields = {};
21060
+ const regularFields = [];
21061
+ const skippedFields = [];
21062
+ for (const field of fields) {
21063
+ const fieldConfig = this.fieldsSchema[nodeName].fields[field];
21064
+ if (!fieldConfig) {
21065
+ skippedFields.push(field);
21066
+ continue;
21067
+ }
21068
+ if (fieldConfig.apiName && fieldConfig.apiName.includes(".")) {
21069
+ const [parent, ...childParts] = fieldConfig.apiName.split(".");
21070
+ const child = childParts.join(".");
21071
+ if (!nestedFields[parent]) {
21072
+ nestedFields[parent] = [];
21073
+ }
21074
+ nestedFields[parent].push(child);
21075
+ } else {
21076
+ regularFields.push(field);
21077
+ }
21078
+ }
21079
+ if (skippedFields.length > 0) {
21080
+ console.log(`Skipped fields not found in ${nodeName} schema:`, skippedFields.join(", "));
21081
+ }
21082
+ const finalFields = [...regularFields];
21083
+ for (const [parent, children] of Object.entries(nestedFields)) {
21084
+ finalFields.push(`${parent}{${children.join(",")}}`);
21085
+ }
21086
+ return finalFields.join(",");
21087
+ }
21088
+ //---- _mapResultToColumns -----------------------------------------------
21089
+ /**
21090
+ * Map API result to requested column names
21091
+ * Only includes fields that exist in schema and were requested
21092
+ * Handles nested fields using apiName mapping
21093
+ *
21094
+ * @param {Object} result - API response result
21095
+ * @param {string} nodeName - Node name for schema lookup
21096
+ * @param {Array<string>} requestedFields - Fields that were requested
21097
+ * @return {Object} Mapped result with only requested columns
21098
+ * @private
21099
+ */
21100
+ _mapResultToColumns(result, nodeName, requestedFields) {
21101
+ const mapped = {};
21102
+ for (const fieldName of requestedFields) {
21103
+ const fieldConfig = this.fieldsSchema[nodeName].fields[fieldName];
21104
+ if (!fieldConfig) {
21105
+ continue;
21106
+ }
21107
+ if (fieldConfig.apiName) {
21108
+ mapped[fieldName] = this._getNestedValue(result, fieldConfig.apiName);
21109
+ } else {
21110
+ mapped[fieldName] = result[fieldName];
21111
+ }
21112
+ }
21113
+ return mapped;
21114
+ }
21115
+ //---- _getNestedValue ---------------------------------------------------
21116
+ /**
21117
+ * Get nested value from object using dot-notation path
21118
+ * @param {Object} obj - Object to search in
21119
+ * @param {string} path - Dot-notation path (e.g. 'creative.id')
21120
+ * @return {*} Value at path or undefined
21121
+ * @private
21122
+ */
21123
+ _getNestedValue(obj, path) {
21124
+ return path.split(".").reduce((current, key) => current == null ? void 0 : current[key], obj);
21125
+ }
18863
21126
  //---- _fetchPaginatedData -----------------------------------------------
18864
21127
  /**
18865
21128
  * Fetch paginated data from Facebook API
18866
21129
  *
18867
21130
  * @param {string} initialUrl - Initial URL to fetch
18868
21131
  * @param {string} nodeName - Node name for field casting
18869
- * @param {string} logContext - Context for logging
21132
+ * @param {Array} fields - Fields that were requested
18870
21133
  * @return {Array} All fetched data
18871
21134
  * @private
18872
21135
  */
18873
- _fetchPaginatedData(initialUrl, nodeName, logContext = "") {
21136
+ _fetchPaginatedData(initialUrl, nodeName, fields) {
18874
21137
  var allData = [];
18875
21138
  var nextPageURL = initialUrl;
18876
21139
  while (nextPageURL) {
@@ -18878,8 +21141,10 @@ API Response: ${JSON.stringify(statusResult, null, 2)}`);
18878
21141
  var jsonData = JSON.parse(response.getContentText());
18879
21142
  if ("data" in jsonData) {
18880
21143
  nextPageURL = jsonData.paging ? jsonData.paging.next : null;
18881
- jsonData.data.forEach((record) => {
18882
- record = this.castRecordFields(nodeName, record);
21144
+ jsonData.data.forEach((record, index) => {
21145
+ let mappedRecord = this._mapResultToColumns(record, nodeName, fields);
21146
+ mappedRecord = this.castRecordFields(nodeName, mappedRecord);
21147
+ jsonData.data[index] = mappedRecord;
18883
21148
  });
18884
21149
  allData = allData.concat(jsonData.data);
18885
21150
  } else {