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

✨Source Snapchat Marketing: Add ability to break-down the Stats streams by report_dimensions query parameter #30761

Conversation

pabloescoder
Copy link
Collaborator

What

Resolves #29948
Added functionality to break down the reports generated by the Snapchat Marketing API by the report_dimensions query parameter by fields such as geo (country, region), demographic (gender, age) and so on. This is supported only for the stats streams (and not the basic streams - see the source.py bottom lines for a list of basic vs stats streams).
Refer: https://marketingapi.snapchat.com/docs/#reporting-insights-and-dimensions

How

Currently we are fetching all the metrics that are available for a particular stats stream. Different report_dimensions parameters support different metrics. Some only support delivery metrics, while others support both delivery and conversion metrics. (See the above link for more info, including delivery vs. conversion metrics).

I added a new (optional) field in spec.json for specifying the report_dimension. When adding a source, users can specify a report_dimension or leave it empty. If users specify a report_dimension, then only the metrics supported by that report_dimension will be added to the query parameter, if the user leaves it blank then all the metrics will be added to the query parameter (same behaviour as before).

Recommended reading order

  1. airbyte-integrations/connectors/source-snapchat-marketing/source_snapchat_marketing/source.py
  2. airbyte-integrations/connectors/source-snapchat-marketing/source_snapchat_marketing/spec.json
  3. airbyte-integrations/connectors/source-snapchat-marketing/source_snapchat_marketing/schemas/basic_stats.json

🚨 User Impact 🚨

No breaking changes.

Pre-merge Actions

Updating a connector ### Community member or Airbyter
  • Grant edit access to maintainers (instructions)
  • Unit & integration tests added

image
All 14 unit tests passed.

Need help with credentials for running integration tests.

@vercel
Copy link

vercel bot commented Sep 26, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 12, 2024 5:47pm

@github-actions
Copy link
Contributor

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
  • If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

@marcosmarxm
Copy link
Member

Hello @pabloescoder, sorry the missing update about your contribution here. I added it to our team backlog and probably they'll return to you in next couple days. I didn't validate the contribution or the method your suggesting to implement the feature.

@pabloescoder
Copy link
Collaborator Author

pabloescoder commented Oct 15, 2023

Hello @pabloescoder, sorry the missing update about your contribution here. I added it to our team backlog and probably they'll return to you in next couple days. I didn't validate the contribution or the method your suggesting to implement the feature.

Hey @marcosmarxm. Alright sure, no worries!

@pabloescoder
Copy link
Collaborator Author

Any updates on this @marcosmarxm?

@lazebnyi lazebnyi self-assigned this Feb 1, 2024
@lazebnyi
Copy link
Collaborator

lazebnyi commented Jul 5, 2024

Connector has migrated to low code - #39507

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Source Snapchat Marketing: Ability to breakdown by report_dimensions in snapchat marketing API
5 participants