MetaAds
借助 MetaAds 连接器,您可以连接到 Meta/Facebook Ads 数据,并对这些数据执行创建、读取、更新和删除操作。
准备工作
在使用 MetaAds 连接器之前,请完成以下任务:
- 在您的 Google Cloud 项目中:
- 将 IAM 角色 roles/connectors.admin 授予该用户 配置连接器。
- 将以下 IAM 角色授予您要用其来使用连接器的服务账号:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
服务账号是一种特殊类型的 Google 账号,用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号,则必须创建一个服务账号。如需了解详情,请参阅创建服务账号。
- 启用以下服务:
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
如需了解如何启用服务,请参阅启用服务。
如果之前没有为您的项目启用这些服务或权限,则在您配置连接器时,系统会提示您启用。
配置连接器
配置连接器时,您需要创建与数据源(即后端系统)的连接。一个连接需专用于一个数据源。这意味着,如果您有许多数据源,则必须为每个数据源创建单独的连接。如需创建连接,请执行以下步骤:
- 在 Cloud 控制台 中,进入 Integration Connectors > 连接页面,然后选择或创建一个 Google Cloud 项目。
- 点击 + 新建以打开创建连接页面。
- 在位置部分中,选择连接的位置。
- 区域:从下拉列表中选择一个位置。
连接器支持的区域包括:
如需查看所有受支持区域的列表,请参阅位置。
- 点击下一步。
- 区域:从下拉列表中选择一个位置。
- 在连接详情部分中,完成以下操作:
- 连接器:从可用连接器下拉列表中选择 MetaAds。
- 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
- 在连接名称字段中,输入连接实例的名称。
连接名称必须符合以下条件:
- 连接名称可以使用字母、数字或连字符。
- 字母必须小写。
- 连接名称必须以字母开头,以字母或数字结尾。
- 连接名称不能超过 49 个字符。
- (可选)输入连接实例的说明。
- 服务账号:选择具有所需角色的服务账号。
- (可选)配置连接节点设置:
- 节点数下限:输入连接节点数下限。
- 节点数上限:输入连接节点数上限。
节点是处理事务的连接单元(或副本)。 连接处理越多事务就需要越多节点,相反,处理越少事务需要越少节点。 如需了解节点如何影响连接器价格,请参阅连接节点的价格。如果未输入任何值,则默认情况下,节点数下限设置为 2(以便提高可用性),节点数上限设置为 50。
- 账号 ID:您的广告账号的 ID。如果未指定,我们会使用从 Facebook 广告返回的第一个广告账号 ID。
- 汇总格式:汇总列或集合列应返回的格式。
- 以页面身份进行身份验证:在向 Facebook 发出请求时,要以哪个页面的身份进行身份验证的页面名称或 ID。
- 重试级别:驱动程序在重试时尝试检索结果的最精细广告对象级别。
- 目标:如果未指定目标,则使用默认目标。用于某些表(如 Comments),可以指定目标。
- (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
- 点击下一步。
-
在身份验证部分中,输入身份验证详细信息。
- 选择身份验证类型,然后输入相关详细信息。
MetaAds 连接支持以下身份验证类型:
- OAuth 2.0 授权代码授权
- 点击下一步。
如需了解如何配置这些身份验证类型,请参阅配置身份验证。
- 选择身份验证类型,然后输入相关详细信息。
- 查看:查看您的连接和身份验证详细信息。
- 点击创建。
配置身份验证
根据您要使用的身份验证输入详细信息。
-
OAuth 2.0 授权代码授权
- 访问令牌:通过基于 auth-code-flow 的连接对请求进行身份验证时所用的访问令牌。
- 客户端 ID:连接器为您创建的应用提供的客户端 ID。
- 客户端密钥:包含您创建的关联应用的客户端密钥的 Secret Manager 密文。
实体、操作和动作
所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。
- 实体:实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如,在数据库连接器中,表是实体;在文件服务器连接器中,文件夹是实体;在消息传递系统连接器中,队列是实体。
但可能的情况是,连接器不支持或不具有任何实体,在这种情况下,
Entities
列表将为空。 - 操作:操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作:
从可用列表中选择一个实体,系统会生成该实体可用的操作列表。如需了解操作的详细说明,请参阅连接器任务的实体操作。但是,如果连接器不支持任何实体操作, 操作未在
Operations
列表中列出。 - 动作:动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改,并且动作因连接器而异。通常,操作将具有一些输入参数和一个输出参数。但可能的情况是,连接器不支持任何动作,在这种情况下,
Actions
列表将为空。
系统限制
MetaAds 连接器每秒可以处理 6 个事务, 每节点, 并throttles任何事务 。 默认情况下,集成连接器会为连接分配 2 个节点(以提高可用性)。
如需了解适用于 Integration Connectors 的限制,请参阅限制。
操作
本部分列出了该连接器支持的操作。如需了解如何配置操作,请参阅操作示例。
CreateAdPreview 操作
为应用数据分析创建架构文件。
CreateAdPreview 操作的输入参数
参数名称 | 数据类型 | 必填 | 说明 |
---|---|---|---|
AdFormat | 字符串 | True | 要使用的广告格式。允许的值包括 AUDIENCE_NETWORK_INSTREAM_VIDEO、AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE、AUDIENCE_NETWORK_OUTSTREAM_VIDEO、AUDIENCE_NETWORK_REWARDED_VIDEO、DESKTOP_FEED_STANDARD、FACEBOOK_STORY_MOBILE、INSTAGRAM_STANDARD、INSTAGRAM_STORY、INSTANT_ARTICLE_STANDARD、INSTREAM_VIDEO_DESKTOP、INSTREAM_VIDEO_MOBILE、MARKETPLACE_MOBILE、MESSENGER_MOBILE_INBOX_MEDIA、MOBILE_BANNER、MOBILE_FEED_BASIC、MOBILE_FEED_STANDARD、MOBILE_FULLWIDTH、MOBILE_INTERSTITIAL、MOBILE_MEDIUM_RECTANGLE、MOBILE_NATIVE、RIGHT_COLUMN_STANDARD、SUGGESTED_VIDEO_DESKTOP、SUGGESTED_VIDEO_MOBILE、WATCH_FEED_MOBILE。 |
AdCreativeId | 字符串 | True | 用于创建预览的广告广告素材的 ID。 |
如需了解如何配置 CreateAdPreview
操作,请参阅操作示例。
操作示例
本部分介绍如何在此连接器中执行一些操作。
示例 - 制作广告预览
- 在
Configure connector task
对话框中,点击Actions
。 - 选择
CreateAdPreview
操作,然后点击完成。 - 在数据映射部分中,
Open Data Mapping Editor
,然后在Input
字段中输入类似于以下内容的值:{ "AdCreativeId": "120208552947120478", "AdFormat": "AUDIENCE_NETWORK_INSTREAM_VIDEO" }
如果操作成功,
CreateAdPreview
任务的 connectorOutputPayload
响应
参数的值类似于以下内容:
[{ "Url": "https://business.facebook.com/ads/api/preview_iframe.php?d=AQL_quk8kLm_6z2oZ14q9A0led9llzr981NPv-zUHhwZ5IXjO07s7ngrI2y0qI0VZCRH2w9hgCwy5xrbFQlWCy0g-uRpRHvFS0dS0erj2Lg4HI7ZfIRm8h3nZLhJygM", "@affectedrows": null }, { "Url": null, "@affectedrows": null }]
实体操作示例
本部分介绍如何在此连接器中执行某些实体操作。
示例 - 列出所有广告账号
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择AdAccounts
。 - 选择
List
操作,然后点击完成。
示例 - 列出所有广告系列
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择Campaigns
。 - 选择
List
操作,然后点击完成。 - (可选)在连接器任务的任务输入部分,您可以执行以下操作: 通过指定过滤子句来过滤结果集。 始终使用英文单引号 (') 指定过滤条件子句值。
示例 - 获取广告集
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择Adsets
。 - 选择
Get
操作,然后点击完成。 - 在连接器任务的任务输入部分,点击实体 ID,然后
然后在 Default Value 字段中输入
120206747969710053
。其中,
120206747969710053
是User
实体中的唯一记录 ID。
在集成中使用 MetaAds 连接
创建连接后,该连接将在 Apigee Integration 和 Application Integration 中可用。您可以使用连接 通过连接器任务在集成中进行集成。
- 如需了解如何在 Apigee Integration 中创建和使用连接器任务,请参阅连接器任务。
- 如需了解如何在 Application Integration 中创建和使用连接器任务,请参阅连接器任务。