route1io_connectors.facebook module

get_age_gender_insights(access_token: str, ad_account_id: str) → pandas.core.frame.DataFrame

Return a pandas.DataFrame containing insights from the last 30 days associated with a Facebook ad account broken down by age and gender.

Parameters

access_token (str) – Access token with ads_read permission generated from a Facebook app.
ad_account_id (str) – Valid ad account ID (i.e. act_123456789101112)

Returns

age_gender_df – pandas.DataFrame containing the requested insights data from the Facebook Marketing API broken down by age and gender

Return type

pandas.DataFrame

get_insights(access_token: str, ad_account_id: str, fields: Optional[list] = None, params: Optional[dict] = None) → pandas.core.frame.DataFrame

Return a pandas.DataFrame containing insights associated with a Facebook ad account.

Parameters

access_token (str) – Access token with ads_read permission generated from a Facebook app.
ad_account_id (str) – Valid ad account ID (i.e. act_123456789101112)
fields (list) – List of valid Facebook Marketing API fields. See Fields table at https://developers.facebook.com/docs/marketing-api/insights/parameters/v10.0 for docs on available fields.
params (dict) – Dict of valid Facebook Marketing API parameters. See Parameters table at https://developers.facebook.com/docs/marketing-api/insights/parameters/v10.0 for docs on available parameters.

Returns

insights_df – pandas.DataFrame containing the requested insights data from the Facebook Marketing API

Return type

pandas.DataFrame

get_region_insights(access_token: str, ad_account_id: str) → pandas.core.frame.DataFrame

Return a pandas.DataFrame containing insights from the last 30 days associated with a Facebook ad account broken down by region.

Parameters

access_token (str) – Access token with ads_read permission generated from a Facebook app.
ad_account_id (str) – Valid ad account ID (i.e. act_123456789101112)

Returns

region_df – pandas.DataFrame containing the requested insights data from the Facebook Marketing API broken down by region

Return type

pandas.DataFrame