商务管理平台 API 明确了访问另一个商务管理平台的受众时应具有的身份和职责。
双方之间共享自定义受众时,首先必须在商务管理平台之间建立合作关系。如要建立合作关系,请前往商务管理平台Business Settings
中的 Partners
部分。提供共享受众的一方还必须确认他们遵守商务管理平台中列明的自定义受众服务条款。请参阅 Facebook > 自定义受众条款。
建立共享关系之后,一个商务管理平台即可与其他商务管理平台共享受众。但是,受众只能单向共享。这意味着,受众是从商务管理平台 #1 共享到商务管理平台 #2。商务管理平台 #2 将无法向商务管理平台 #1 反向共享受众,除非另外建立了从商务管理平台 #2 共享到商务管理平台 #1 的关系。
自 2018 年以来,为了在商务管理平台之间共享自定义受众,这类商务管理平台应该建立以下受众共享关系。您需要商务管理平台管理员权限来请求建立共享受众的关系。如果两个商务管理平台已建立这种关系,则广告主可直接与另一个商务管理平台共享受众。另请参阅参考文档 > 自定义受众和参考文档 > 自定义受众共享账户信息。
如要创建关系,请向特定 custom_audience_id
发出以下调用:
POST {custom_audience_id}/adaccounts?adaccounts=[<ad_account_id>]&relationship_type=[<relationship_type>]
我们会根据与另一个商务管理平台的关系状况处理请求:
Facebook 会为请求中传递的每个广告账户返回一个 sharing_data
对象。例如:
{ success: true, sharing_data : [ { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "in progress" "errors" : [] }, ... ] }
用于此请求的选项和参数包括:
层级 | 描述 |
---|---|
类型:list:numericstring | 您想与之共享受众的广告账户编号。 |
类型:list:string | 必要。 表示拥有受众的商务管理平台与接收共享受众的商务管理平台之间的关系。由所有适用值构成的一个数组。 可能的值: |
如果您不具备商务管理平台的管理员权限,而又尝试共享受众,您会收到与以下情况类似的错误消息:
[ { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "not shared" "errors" : [ "You don't have permission to initiate a sharing relationship for this ad account/business" ] } ... ]
您提出请求后,如果负责接收的广告账户所属的商务管理平台与您未建立关系,该商务管理平台可能会收到一个待处理的共享受众关系确认请求。这一状态会出现在商务管理平台中。这时,该商务管理平台可以批准或拒绝此关系确认请求:
POST <SHARING_RELATIONSHIP_ID>?request_response=approve
若请求成功,商务管理平台会收到以下响应:
{ success: bool }
选项包括:
名称 | 描述 |
---|---|
类型:字符串 | 收到关系确认请求的商务管理平台是批准还是拒绝了请求。 可能的值: |
收到关系确认请求的商务管理平台批准请求之后,您就可以向其提供共享受众。您提出请求时,sharing_data
将如下所示:
[ { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "shared" "errors" : [] } ... ]
如果您是商务管理平台的管理员,并针对一个待处理的关系确认请求共享了一个受众,Facebook 会将该受众编号附加到现有关系中:
[ { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "in progress" "errors" : [] } ... ]
由于您可以在请求中指定多个广告账户,响应中会出现每个账户的结果:
[ { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "shared" "errors" : [] } { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "in progress" "errors" : [] } { "ad_acct_id": "<AD_ACCOUNT_ID>" "audience_share_status" : "not shared" "errors" : [ "You don't have permission to initiate a sharing relationship for this ad account/business" ] } ... ]
如要查看您商务管理平台收到的受众共享请求,方法如下:
GET <BUSINESS_ID>/received_audience_sharing_requests?fields=custom_audiences,initiator,recipient,relationship_type,request_status,request_type
响应如下所示:
{ "data": [ { "initiator": { "id": "<BUSINESS_ID>", "name": "business_name1" }, "recipient": { "id": "<BUSINESS_ID>", "name": "business_name2" }, "request_status": "IN_PROGRESS", "relationship_type": "[<relationship_type>]", "id": "<SHARING_RELATIONSHIP_ID>", "custom_audiences": [ { "id": "<CUSTOM_AUDIENCE_ID>", "name": "<CUSTOM_AUDIENCE_NAME>", "share_account_name": "<ACCOUNT_NAME>", "share_account_id": "<ACCOUNT_ID>" } ] } ... ], "paging": { "cursors": { "before": "<CURSOR>", "after": "<CURSOR>" } } }
如要查看您商务管理平台发送的有关向其他商务管理平台提供共享受众的请求,请发出以下调用:
GET <BUSINESS_ID>/initiated_audience_sharing_requests?fields=custom_audiences,initiator,recipient,relationship_type,request_status,request_type
响应如下所示:
{ "data": [ { "initiator": { "id": "<BUSINESS_ID>", "name": "business_name1" }, "recipient": { "id": "<BUSINESS_ID>", "name": "business_name2" }, "request_status": "IN_PROGRESS", "relationship_type": "[<relationship_type>]", "id": "<SHARING_RELATIONSHIP_ID>", "custom_audiences": [ { "id": "<CUSTOM_AUDIENCE_ID>", "name": "<CUSTOM_AUDIENCE_NAME>", "share_account_name": "<ACCOUNT_NAME>", "share_account_id": "<ACCOUNT_ID>" } ] } ... ], "paging": { "cursors": { "before": "<CURSOR>", "after": "<CURSOR>" } } }