airflow.providers.facebook.ads.hooks.ads¶

此模块包含 Facebook 广告报告钩子。

类¶

`JobStatus`	Facebook 异步任务状态的可用选项。
`FacebookAdsReportingHook`	Facebook 广告 API。

class airflow.providers.facebook.ads.hooks.ads.JobStatus[source]¶

Facebook 异步任务状态的可用选项。

class airflow.providers.facebook.ads.hooks.ads.FacebookAdsReportingHook(facebook_conn_id=default_conn_name, api_version=None)[source]¶

Facebook 广告 API。

另请参阅

有关 Facebook 广告 API 的更多信息，请查看 API 文档：https://developers.facebook.com/docs/marketing-apis/

参数：

facebook_conn_id (str) – Airflow Facebook 广告连接 ID
api_version (str | None) – Facebook API 的版本。默认为 None。如果为 None，将使用 Facebook business SDK 的默认版本。

client_required_fields = ['app_id', 'app_secret', 'access_token', 'account_id'][source]¶

property multiple_accounts: bool[source]¶

检查 Facebook Ads 连接中提供的 `account_id` 是否以列表形式提供。

property facebook_ads_config: dict[source]¶

获取 `facebook_ads_config` 属性。

这会从元数据库中获取 Facebook Ads 连接，并使用返回的配置文件设置 `facebook_ads_config` 属性。

bulk_facebook_report(params, fields, sleep_time=5)[source]¶

从 Facebook Ads API 拉取有关 Account ID 的数据，并匹配返回类型。

返回类型和值取决于 `account_id` 配置。如果配置是表示单个 Account ID 的字符串，则返回值为该 ID 的报告列表。如果配置是表示多个 Account ID 的字符串列表，则返回值为 Account ID 及其各自报告列表的字典。

参数：

fields (list[str]) – 从 Facebook 获取的字段列表。在 `AdsInsights.Field` 类中找到。https://developers.facebook.com/docs/marketing-api/insights/parameters/v6.0
params (dict[str, Any] | None) – 确定 Facebook 查询的参数https://developers.facebook.com/docs/marketing-api/insights/parameters/v6.0
sleep_time (int) – 发生异步调用时等待的时间

返回：

Facebook Ads API 响应，根据给定的 Account ID 类型转换为 Facebook Ads Row 对象

返回类型：

list[facebook_business.adobjects.adsinsights.AdsInsights] | dict[str, list[facebook_business.adobjects.adsinsights.AdsInsights]]