Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update source-facebook-marketing for multiple account ids #1790

Merged
merged 1 commit into from
Nov 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@ The following data resources are supported:
* [Ad activities](https://developers.facebook.com/docs/marketing-api/reference/ad-activity)
* [Ad creatives](https://developers.facebook.com/docs/marketing-api/reference/ad-creative)
* [Ad insights](https://developers.facebook.com/docs/marketing-api/reference/adgroup/insights/)
* [Ad sets](https://developers.facebook.com/docs/marketing-api/reference/ad-campaign/v19.0)
* [Business ad accounts](https://developers.facebook.com/docs/marketing-api/reference/business/adaccount/)
* [Campaigns](https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group)
* [Custom Conversions](https://developers.facebook.com/docs/marketing-api/reference/custom-conversion/v19.0)
* [Images](https://developers.facebook.com/docs/marketing-api/reference/ad-image)
* [Videos](https://developers.facebook.com/docs/graph-api/reference/video/)

Expand Down Expand Up @@ -89,7 +91,7 @@ are a subset of breakdowns that must be specified separately.
| Property | Title | Description | Type | Required/Default |
|---|---|---|---|---|
| **`/access_token`** | Access Token | The value of the access token generated. | string | Required |
| **`/account_id`** | Account ID | The Facebook Ad account ID to use when pulling data from the Facebook Marketing API. | string | Required for [manual authentication](#configuring-manually-with-an-access-token) only |
| **`/account_ids`** | Account IDs | A comma delimited string of Facebook Ad account IDs to use when pulling data from the Facebook Marketing API. | string | Required |
| `/custom_insights` | Custom Insights | A list which contains insights entries. Each entry must have a name and can contains fields, breakdowns or action_breakdowns | array | |
| _`/custom_insights/-/action_breakdowns`_ | Action Breakdowns | A list of chosen action_breakdowns to apply | array | `[]` |
| _`/custom_insights/-/action_breakdowns/-`_ | ValidActionBreakdowns | Generic enumeration. Derive from this class to define new enumerations. | string | |
Expand Down Expand Up @@ -128,7 +130,7 @@ captures:
image: ghcr.io/estuary/source-facebook-marketing:dev
config:
access_token: <secret>
account_id: 000000000000000
account_ids: "000000000000000,111111111111111"
start_date: 2022-03-01T00:00:00Z
custom_insights:
- name: my-custom-insight
Expand Down Expand Up @@ -177,6 +179,10 @@ captures:
stream: campaigns
syncMode: incremental
target: ${PREFIX}/campaigns
- resource:
stream: custom_conversions
syncMode: full_refresh
target: ${PREFIX}/custom_conversions
- resource:
stream: activities
syncMode: incremental
Expand Down
Loading