Skip to content

Commit f4b58c1

Browse files
authored
Merge pull request #5142 from segmentio/facebook-cloud-source-note
Add Facebook Insights Breakdown Table
2 parents d17bf1d + c9fe054 commit f4b58c1

File tree

1 file changed

+20
-7
lines changed
  • src/connections/sources/catalog/cloud-apps/facebook-ads

1 file changed

+20
-7
lines changed

src/connections/sources/catalog/cloud-apps/facebook-ads/index.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Collections are the groupings of resources we pull from your source. In your war
5757

5858
## Collection Properties
5959

60-
Below are tables outlining the properties included in the collections listed above.
60+
The following tables outline the properties included in collections.
6161

6262
### Ad Accounts
6363

@@ -123,20 +123,33 @@ Below are tables outlining the properties included in the collections listed abo
123123
| clicks | The number of clicks on your ads. |
124124
| date_start | The start date for your data. |
125125
| date_stop | The end date for your data. |
126-
| ~~deeplink_clicks~~ | *Deprecated by Facebook.* Aliased to `click_to_app_deeplink`. |
127-
| ~~website_clicks~~ | *Deprecated by Facebook.* Aliased to `click_to_website` |
128126
| frequency | The average number of times each person saw your ad. |
129127
| impressions | The number of times your ads were on screen. |
130128
| inline_post_engagements | The total number of actions that people take involving your ads. |
131-
| ~~social_clicks~~ | *Deprecated by Facebook.* The number of clicks (all) when your ad was displayed with social information. |
132-
| ~~social_impressions~~ | *Deprecated by Facebook.* The number of times your ads were viewed when displayed with social information. |
133129
| social_spend | The total amount you've spent so far for your ads showed with social information. |
134130
| spend | The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. |
135131
| unique_clicks | The number of people who performed a click (all). This metric is estimated. |
136132
| unique_impressions | Deprecated in favor of `reach` . You can continue to query `unique_impressions` for this metric, but zero-values will now be `null`. |
137-
| ~~unique_social_clicks~~ | *Deprecated by Facebook.* The number of people who performed a click (all) on your ad when it was displayed with social information. |
138133
| reach | The number of people who saw your ads at least once. Reach is different from impressions, which may include multiple views of your ads by the same people. |
139-
| ~~call_to_action_clicks~~ | *Deprecated by Facebook.* The number of times people clicked the call-to-action button on your ad. |
134+
135+
#### Insights Breakdowns
136+
137+
Segment also supports Breakdowns for Insights. Breakdowns are not enabled by default; [reach out to Segment support](https://segment.com/help/contact/){:target="_blank"} to enable them. Segment supports the following properties:
138+
139+
| Property Name | Description |
140+
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
141+
| `actions` | The total number of actions people took that are attributed to your ads. |
142+
| `actions_values` | The total value of all conversions attributed to your ads. |
143+
| `unique_actions` | The total number of unique actions attributed to your ads. |
144+
| `video_p25_watched_actions` | The number of times your video played at 25% of its length, including plays that skipped to this point. |
145+
| `video_p50_watched_actions` | The number of times your video played at 50% of its length, including plays that skipped to this point. |
146+
| `video_p75_watched_actions` | The number of times your video played at 75% of its length, including plays that skipped to this point. |
147+
| `video_p95_watched_actions` | The number of times your video played at 95% of its length, including plays that skipped to this point. |
148+
| `video_p100_watched_actions` | The number of times your video played at 100% of its length, including plays that skipped to this point. |
149+
| `video_30_sec_watched_actions` | The number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. |
150+
| `video_avg_time_watched_actions` | The average time a video played, including any time spent replaying the video for a single impression. |
151+
152+
For more information, view [Meta's Insights documentation](https://developers.facebook.com/docs/marketing-api/reference/ads-insights/){:target="_blank"}.
140153

141154
## Adding Destinations
142155

0 commit comments

Comments
 (0)