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 docs #29053

Merged
merged 12 commits into from
Aug 9, 2023
Merged

Conversation

ChristoGrab
Copy link
Contributor

What

Updated the docs page for Facebook Marketing source.

How

  • Moved OSS-specific instructions to top of setup steps
  • Merged OSS/Cloud steps where possible
  • Updated descriptions of configurations, particularly for Custom insights inputs

@ChristoGrab ChristoGrab changed the title Docs: Update Source Facebook marketing docs Docs: Update Source Facebook Marketing docs Aug 3, 2023
@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Aug 3, 2023
@ChristoGrab ChristoGrab marked this pull request as ready for review August 3, 2023 17:26
5. To authenticate the connection:

<!-- env:cloud -->
**For Airbyte Cloud**: Click **Authenticate your account** to authorize your [Meta for Developers](https://developers.facebook.com/) account. Airbyte will authenticate the account you are already logged in to. Make sure you are logged into the right account.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why Meta For Developers account? do I need to be registered as a meta developer to use on Airbyte Cloud? That doesn't sound right

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry bout that, got my Metas and Facebooks mixed up!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh it wasn't about fb vs meta I just meant that the user shouldn't need to be a developer to use the connector. I can just be a casual

docs/integrations/sources/facebook-marketing.md Outdated Show resolved Hide resolved
Pay attention, that not all fields (e.g. conversions, conversion_values) will be returned for AdInsights, see [docs](https://developers.facebook.com/docs/marketing-api/reference/ads-action-stats/).
To get all fields You should use custom insights with **breakdowns**.

Please note that not all fields, such as `conversions` and `conversion_values`, will be returned when accessing AdInsights. Refer to the [Facebook documentation](https://developers.facebook.com/docs/marketing-api/reference/ads-action-stats/) for more information. To retrieve all available fields, it is recommended to use Custom Insights and specify the necessary **breakdowns**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is AdInsights referring to here? the casing makes it sound like a specific thing like a class or specific stream. Should it be ad insights?

Why would conversions not be returned? That seems weird given that conversions are an important part of ad analytics. Can we give the user a bit more info about when & why this happens? The link didn't provide more clarity for me personally

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I've looked into this further and can't find any relevant information in the API docs. There's a ticket in Stack Overflow about missing conversion data in Ad Insights, but it's not much to go by and doesn't seem to be directly related to the note in the docs:

https://stackoverflow.com/questions/68196940/facebook-insights-api-conversions-are-not-matching-facebook-ads-manager-results

I've commented out the note for now since I can't find anything to back it up, and it doesn't seem to be an issue that crops up in the Airbyte Slack channels. I'll keep looking into this!

3. (Optional) For **Fields**, use the dropdown list to select the fields you want to pull from the Facebook Marketing API.
4. (Optional) For **Breakdowns**, use the dropdown list to select the breakdowns you want to configure.
5. (Optional) For **Action Breakdowns**, use the dropdown list to select the action breakdowns you want to configure.
6. (Optional) For **Action Report Time**, enter the action report time you want to configure. This value determines the timing used to report action statistics. For example, if a user sees an ad on Jan 1st but converts on Jan 2nd, this value will determine how the action is reported.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great clarifications added here!

@ChristoGrab ChristoGrab merged commit b3da3f5 into master Aug 9, 2023
@ChristoGrab ChristoGrab deleted the facebook-marketing-docs branch August 9, 2023 17:11
harrytou pushed a commit to KYVENetwork/airbyte that referenced this pull request Sep 1, 2023
* update setup steps

* more updates to setup steps

* formatting fixes

* minor fixes

* add action report time values

* rewrite lookback

* update descriptions of lookback windows

* last update

* small fix

* remove unverified ad insights note

* Update docs/integrations/sources/facebook-marketing.md

Co-authored-by: Sherif A. Nada <snadalive@gmail.com>

---------

Co-authored-by: Sherif A. Nada <snadalive@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation connectors/source/facebook-marketing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants