https://github.com/fbsamples/optimate
Sample codes that allows to fetch different Reach and Frequency curves from the Facebook Marketing API.
https://github.com/fbsamples/optimate
campaign-planner facebook-api frequency-analysis marketing-api planning reach-curves
Last synced: 10 months ago
JSON representation
Sample codes that allows to fetch different Reach and Frequency curves from the Facebook Marketing API.
- Host: GitHub
- URL: https://github.com/fbsamples/optimate
- Owner: fbsamples
- License: other
- Archived: true
- Created: 2021-07-13T16:05:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-21T15:23:25.000Z (over 2 years ago)
- Last Synced: 2025-03-13T13:34:23.914Z (11 months ago)
- Topics: campaign-planner, facebook-api, frequency-analysis, marketing-api, planning, reach-curves
- Language: Python
- Homepage:
- Size: 138 MB
- Stars: 12
- Watchers: 6
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## Note: Discontinuing OptiMate
21 June 2023: Please note that any information, guidance, or assistance provided herein is valid as of April 2023. This is no longer a maintained project, so as sources, technologies, and best practices evolve over time, the content may no longer be applicable or accurate.
# OptiMate
Pre-built sample codes in Python that allows to take advantage of the Meta's Reach & Frequency API to compare different strategies when planning campaigns for branding purposes. To take a deeper look, visit our [OptiMate Micro-website](https://fbsamples.github.io/OptiMate/).
## Examples
Use case Module 01: When planning campaigns under Reach & Frequency buying type, it is possible to fetch predictions on reach (people), frequency and CPMs, given specific campaign parameters such as: audience, dates, budget, placements and frequency control caps.
Using Module 01, it is possible to compare 5 different objectives: Reach, Brand Awareness, Video Views, Link clicks and Engagement. The code provides different charts showing predicted metrics under specific budgets on the following variables: Reach (number of people), Reach % (percentage of the potential audience), Total frequency (during the specified period), Weekly frequency (Total frequency divided by the number of weeks of the campaign) and Cost Per Mille (CPM). In addition, a CSV file is exported to have all the Reach & Frequency curves data in detail for further analysis.
## Example for Reach (people):
## Example for Total frequency:
## Example for Cost Per Mille (CPM):
## Requirements
Sample codes in Python works with any operative system that is able to work on Python.
## Installing Facebook_business
Before you use any Module from this Toolkit, it is needed to install the latest version of the Facebook_business SDK in Python. You can refer to the following documentation to install the Python SDK and complete all the pre-requisites specified in the facebook-python-business-sdk/README.md file:
https://github.com/facebook/facebook-python-business-sdk
IMPORTANT: It is highly recommended to uninstall any other previous version of the Facebook_business. It can be done via pip:
*pip uninstall Facebook_business
## How OptiMate works
Different use cases are covered in different Modules. Each module runs a specific code with an expected outcome. Take a look at each Module use case description in the DOCUMENTATION.txt file to choose the one that best fits your needs.
Once a specific module is selected, you need to add your own Ad Account ID and Access Token credentials to make the calls.
## Full documentation
Read the full documentation on the DOCUMENTATION.txt file
## Join the fbsamples community
* Website: https://github.com/fbsamples
See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.
## License
OptiMate is licensed under the LICENSE file in this repository.