airflow.providers.facebook.ads.hooks.ads
¶
This module contains Facebook Ads Reporting hooks
Module Contents¶
-
class
airflow.providers.facebook.ads.hooks.ads.
JobStatus
[source]¶ Bases:
enum.Enum
Available options for facebook async task status
-
class
airflow.providers.facebook.ads.hooks.ads.
FacebookAdsReportingHook
(facebook_conn_id: str = default_conn_name, api_version: Optional[str] = None)[source]¶ Bases:
airflow.hooks.base.BaseHook
Hook for the Facebook Ads API
See also
For more information on the Facebook Ads API, take a look at the API docs: https://developers.facebook.com/docs/marketing-apis/
- Parameters
-
facebook_ads_config
(self)[source]¶ Gets Facebook ads connection from meta db and sets facebook_ads_config attribute with returned config file
-
bulk_facebook_report
(self, params: Dict[str, Any], fields: List[str], sleep_time: int = 5)[source]¶ Pulls data from the Facebook Ads API
- Parameters
fields (Dict[str, Any]) -- List of fields that is obtained from Facebook. Found in AdsInsights.Field class. https://developers.facebook.com/docs/marketing-api/insights/parameters/v6.0
params -- Parameters that determine the query for Facebook https://developers.facebook.com/docs/marketing-api/insights/parameters/v6.0
sleep_time (int) -- Time to sleep when async call is happening
- Returns
Facebook Ads API response, converted to Facebook Ads Row objects
- Return type
List[AdsInsights]