FacebookAdsReportToGcsOperator

Google

Fetches the results from the Facebook Ads API as desired in the params Converts and saves the data as a temporary JSON file Uploads the JSON to Google Cloud Storage

View on GitHub

Last Updated: Sep. 13, 2022

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

bucket_nameRequiredThe GCS bucket to upload to

object_nameRequiredGCS path to save the object. Must be the full file path (ex. path/to/file.txt)

gcp_conn_idAirflow Google Cloud connection ID

facebook_conn_idAirflow Facebook Ads connection ID

api_versionThe version of Facebook API. Default to None. If it is None, it will use the Facebook business SDK default version.

fieldsRequiredList of fields that is obtained from Facebook. Found in AdsInsights.Field class. https://developers.facebook.com/docs/marketing-api/insights/parameters/v6.0

parametersParameters that determine the query for Facebook https://developers.facebook.com/docs/marketing-api/insights/parameters/v6.0

gzipOption to compress local file or file data for upload

upload_as_accountOption to export file with account_id This parameter only works if Account Id sets as array in Facebook Connection If set as True, each file will be exported in a separate file that has a prefix of account_id If set as False, a single file will be exported for all account_id

impersonation_chainOptional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

Documentation

Fetches the results from the Facebook Ads API as desired in the params Converts and saves the data as a temporary JSON file Uploads the JSON to Google Cloud Storage

Example DAGs

facebook_ads_to_gcs

Example Airflow DAG that shows how to use FacebookAdsReportToGcsOperator.

Big Data & AnalyticsData Processing